feat!: migrate API to microgenerator

.coveragerc

@@ -32,4 +32,8 @@ omit =
   */gapic/*.py
   */proto/*.py
   */core/*.py
-  */site-packages/*.py
+  */site-packages/*.py
+  google/cloud/__init__.py
+  google/cloud/translate.py
+  google/cloud/translate/__init__.py
+  google/cloud/translation*/*.py

README.rst

@@ -55,11 +55,12 @@ 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-translate==2.0.1.
 
 
 Mac/Linux

UPGRADING.md

@@ -0,0 +1,182 @@
+# 3.0.0 Migration Guide
+
+The 3.0 release of the `google-cloud-translate` 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-translate/issues).
+
+## Supported Python Versions
+
+> **WARNING**: Breaking change
+
+The 3.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-translate
+```
+
+* The script `fixup_translation_{version}_keywords.py` is shipped with the library. It expects
+an input directory (with the code to convert) and an empty destination directory.
+
+```sh
+$ fixup_translation_v3_keywords.py --input-directory .samples/ --output-directory samples/
+```
+
+**Before:**
+```py
+from google.cloud import translate
+
+client = translate.TranslationServiceClient()
+parent = client.location_path(<PROJECT_ID>, <LOCATION>)
+
+response = client.translate_text(
+    parent=parent,
+    contents=[text],
+    mime_type="text/plain",
+    source_language_code="en-US",
+    target_language_code="fr",
+)
+```
+
+
+**After:**
+```py
+from google.cloud import translate
+
+client = translate.TranslationServiceClient()
+parent = "projects/<PROJECT_ID>/locations/<LOCATION>"
+
+response = client.translate_text(
+    request={
+        "parent": parent,
+        "contents": [text],
+        "mime_type": "text/plain",
+        "source_language_code": "en-US",
+        "target_language_code": "fr"
+    }
+)
+```
+
+### More Details
+
+In `google-cloud-translate<3.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
+
+**Before:**
+```py
+    def translate_text(
+        self,
+        contents,
+        target_language_code,
+        parent,
+        mime_type=None,
+        source_language_code=None,
+        model=None,
+        glossary_config=None,
+        labels=None,
+        retry=google.api_core.gapic_v1.method.DEFAULT,
+        timeout=google.api_core.gapic_v1.method.DEFAULT,
+        metadata=None,
+    ):
+```
+
+In the 3.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/cloud/translate/v3/translation_service.proto#L55) specified by the API producer.
+
+
+**After:**
+```py
+    def translate_text(
+        self,
+        request: translation_service.TranslateTextRequest = None,
+        *,
+        parent: str = None,
+        target_language_code: str = None,
+        contents: Sequence[str] = None,
+        model: str = None,
+        mime_type: str = None,
+        source_language_code: str = None,
+        retry: retries.Retry = gapic_v1.method.DEFAULT,
+        timeout: float = None,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> translation_service.TranslateTextResponse:
+```
+
+> **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.translate_text(
+    request={
+        "parent": parent,
+        "target_language_code": target_language_code,
+        "contents": contents
+    }
+)
+```
+
+```py
+response = client.translate_text(
+    parent=parent,
+    target_language_code=target_language_code,
+    contents=contents
+)
+```
+
+This call is invalid because it mixes `request` with a keyword argument `target_language_code`. Executing this code
+will result in an error.
+
+```py
+response = client.translate_text(
+    request={
+        "parent": parent,
+        "contents": contents,
+    },
+    target_language_code=target_language_code
+)
+```
+
+
+
+## Enums and types
+
+
+> **WARNING**: Breaking change
+
+The submodule `enums` (containing enum classes for long running operation State) has been removed.
+
+The submodule `types` is still present. When using the primary version module alias (`translate`)
+it is possible to access the types classes directly.
+
+```py
+from google.cloud import translate  # the primary version is imported by default
+
+client = translate.TranslationServiceClient()
+
+glossary_config = client.TranslateTextGlossaryConfig(
+    glossary=glossary_path
+)
+```
+
+When a specific version is imported, the full module name must be specified to access types classes.
+
+```py
+from google.cloud import translate_v3beta1 as translate
+
+client = translate.TranslationServiceClient()
+
+glossary_config = client.types.TranslateTextGlossaryConfig(
+    glossary=glossary_path
+)
+```

docs/UPGRADING.md

@@ -0,0 +1 @@
+../UPGRADING.md

docs/index.rst

@@ -13,15 +13,41 @@ want to import from ``google.cloud.translate_v3beta1`` in lieu of
 ``google.cloud.translate``. The previous release ``v2`` is also available.
 Import from ``google.cloud.translate_v2`` to use this release.
 
-
+v3 API Reference
+----------------
 .. toctree::
    :maxdepth: 2
 
-   v3
-   v3beta1
+   Client (v3) <translate_v3/services>
+   Types (v3) <translate_v3/types>
+
+v3beta1 API Reference
+---------------------
+.. toctree::
+   :maxdepth: 2
+
+   Client (v3beta1) <translate_v3beta1/services>
+   Types (v3beta1) <translate_v3beta1/types>
+
+v2 API Reference
+----------------
+.. toctree::
+   :maxdepth: 2
+
    v2
 
 
+Migration Guide
+---------------
+
+See the guide below for instructions on migrating to the 3.x release of this library.
+
+.. toctree::
+    :maxdepth: 2
+
+    UPGRADING
+
+
 Changelog
 ---------
 

docs/translate_v3/services.rst

@@ -0,0 +1,6 @@
+Services for Google Cloud Translation v3 API
+============================================
+
+.. automodule:: google.cloud.translate_v3.services.translation_service
+    :members:
+    :inherited-members:

docs/translate_v3/types.rst

@@ -0,0 +1,5 @@
+Types for Google Cloud Translation v3 API
+=========================================
+
+.. automodule:: google.cloud.translate_v3.types
+    :members:

docs/translate_v3beta1/services.rst

@@ -0,0 +1,6 @@
+Services for Google Cloud Translation v3beta1 API
+=================================================
+
+.. automodule:: google.cloud.translate_v3beta1.services.translation_service
+    :members:
+    :inherited-members:

docs/translate_v3beta1/types.rst

@@ -0,0 +1,5 @@
+Types for Google Cloud Translation v3beta1 API
+==============================================
+
+.. automodule:: google.cloud.translate_v3beta1.types
+    :members: