Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
feat!: migrate to microgenerator (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
arithmetic1728 committed Jul 16, 2020
1 parent d367b9e commit aa9b20c
Show file tree
Hide file tree
Showing 71 changed files with 44,696 additions and 41,481 deletions.
8 changes: 5 additions & 3 deletions README.rst
@@ -1,7 +1,7 @@
Python Client for Google Kubernetes Engine API
==============================================

|ga| |pypi| |versions|
|ga| |pypi| |versions|

`Google Kubernetes Engine API`_: The Google Kubernetes Engine API is used for
building and managing container based applications, powered by the open source
Expand Down Expand Up @@ -49,11 +49,13 @@ dependencies.

Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Python >= 3.5
Python >= 3.6

Deprecated Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
Python == 2.7.

The last version of this library compatible with Python 2.7 is google-cloud-container==1.0.1


Mac/Linux
Expand Down
154 changes: 154 additions & 0 deletions UPGRADING.md
@@ -0,0 +1,154 @@
# 2.0.0 Migration Guide

The 2.0 release of the `google-cloud-container` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.

If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-container/issues).

## Supported Python Versions

> **WARNING**: Breaking change
The 2.0.0 release requires Python 3.6+.


## Method Calls

> **WARNING**: Breaking change
Methods expect request objects. We provide a script that will convert most common use cases.

* Install the library

```py
python3 -m pip install google-cloud-container
```

* The script `fixup_container_v1_keywords.py` and `fixup_container_v1beta1_keywords.py`
are shipped with the library. It expects an input directory (with the code to convert) and an empty destination directory.

```sh
$ fixup_container_v1_keywords.py --input-directory .samples/ --output-directory samples/
```

**Before:**
```py
from google.cloud import container_v1

client = container_v1.ClusterManagerClient()

clusters = client.list_clusters(
project_id="project_id", zone="us-central1-a", parent="parent"
)
```


**After:**
```py
from google.cloud import container_v1

client = container_v1.ClusterManagerClient()

clusters = client.list_clusters(
request = {'project_id': "project_id", 'zone': "us-central1-a", 'parent': "parent"}
)
```

### More Details

In `google-cloud-container<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.

**Before:**
```py
def list_clusters(
self,
project_id=None,
zone=None,
parent=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
```

In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.

Some methods have additional keyword only parameters. The available parameters depend on the [`google.api.method_signature` annotation](https://github.com/googleapis/googleapis/blob/master/google/container/v1/cluster_service.proto#L48) specified by the API producer.


**After:**
```py
def list_clusters(
self,
request: cluster_service.ListClustersRequest = None,
*,
project_id: str = None,
zone: str = None,
parent: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> cluster_service.ListClustersResponse:
```

> **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
> Passing both will result in an error.

Both of these calls are valid:

```py
response = client.list_clusters(
request={
"project_id": project_id,
"zone": zone,
"parent": parent,
}
)
```

```py
response = client.list_clusters(
project_id=project_id,
zone=zone,
parent=parent,
)
```

This call is invalid because it mixes `request` with a keyword argument `parent`. Executing this code will result in an error.

```py
response = client.list_clusters(
request={
"project_id": project_id,
"zone": zone,
},
parent=parent
)
```



## Enums and Types


> **WARNING**: Breaking change
The submodules `enums` and `types` have been removed.

**Before:**
```py

from google.cloud import container

status = container.enums.Cluster.Status.RUNNING
cluster = container.types.Cluster(name="name")
```


**After:**
```py
from google.cloud import container

status = container.Cluster.Status.RUNNING
cluster = container.Cluster(name="name")
```
1 change: 1 addition & 0 deletions docs/UPGRADING.md
6 changes: 6 additions & 0 deletions docs/container_v1/services.rst
@@ -0,0 +1,6 @@
Services for Google Container v1 API
====================================

.. automodule:: google.cloud.container_v1.services.cluster_manager
:members:
:inherited-members:
5 changes: 5 additions & 0 deletions docs/container_v1/types.rst
@@ -0,0 +1,5 @@
Types for Google Container v1 API
=================================

.. automodule:: google.cloud.container_v1.types
:members:
6 changes: 6 additions & 0 deletions docs/container_v1beta1/services.rst
@@ -0,0 +1,6 @@
Services for Google Container v1beta1 API
=========================================

.. automodule:: google.cloud.container_v1beta1.services.cluster_manager
:members:
:inherited-members:
5 changes: 5 additions & 0 deletions docs/container_v1beta1/types.rst
@@ -0,0 +1,5 @@
Types for Google Container v1beta1 API
======================================

.. automodule:: google.cloud.container_v1beta1.types
:members:
6 changes: 0 additions & 6 deletions docs/gapic/v1/api.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/gapic/v1/types.rst

This file was deleted.

28 changes: 25 additions & 3 deletions docs/index.rst
Expand Up @@ -4,11 +4,33 @@

API Reference
-------------

v1
-------------
.. toctree::
:maxdepth: 2
:maxdepth: 2

container_v1/services
container_v1/types

v1beta1
-------------
.. toctree::
:maxdepth: 2

container_v1beta1/services
container_v1beta1/types

Migration Guide
---------------

See the guide below for instructions on migrating to the 2.x release of this library.

.. toctree::
:maxdepth: 2

UPGRADING

gapic/v1/api
gapic/v1/types

Changelog
---------
Expand Down
8 changes: 0 additions & 8 deletions google/__init__.py

This file was deleted.

8 changes: 0 additions & 8 deletions google/cloud/__init__.py

This file was deleted.

0 comments on commit aa9b20c

Please sign in to comment.