feat: Migrate API to use python micro-generator (#41)

* migrate API to use micro-generator * migrate API to use micro-generator * update * doc changes * add samples * add samples * add samples and readme * Update README.md * Update README.md * Update UPGRADING.md file * update synth.py Co-authored-by: arithmetic1728 <[email protected]>
googleapis · Oct 16, 2020 · e6107d6 · e6107d6
1 parent f5eaebc
commit e6107d6
Show file tree

Hide file tree

Showing 82 changed files with 11,359 additions and 997 deletions.
diff --git a/packages/google-cloud-language/.coveragerc b/packages/google-cloud-language/.coveragerc
@@ -23,16 +23,14 @@ omit =
 [report]
 fail_under = 100
 show_missing = True
+omit = google/cloud/language/__init__.py
 exclude_lines =
     # Re-enable the standard pragma
     pragma: NO COVER
     # Ignore debug-only repr
     def __repr__
-    # Ignore abstract methods
-    raise NotImplementedError
-omit =
-  */gapic/*.py
-  */proto/*.py
-  */core/*.py
-  */site-packages/*.py
-  google/cloud/__init__.py
+    # Ignore pkg_resources exceptions.
+    # This is added at the module level as a safeguard for if someone
+    # generates the code and tries to run it without pip installing. This
+    # makes it virtually impossible to test properly.
+    except pkg_resources.DistributionNotFound
diff --git a/packages/google-cloud-language/.kokoro/samples/python3.6/common.cfg b/packages/google-cloud-language/.kokoro/samples/python3.6/common.cfg
@@ -13,6 +13,12 @@ env_vars: {
     value: "py-3.6"
 }
 
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-py36"
+}
+
 env_vars: {
     key: "TRAMPOLINE_BUILD_FILE"
     value: "github/python-language/.kokoro/test-samples.sh"

diff --git a/packages/google-cloud-language/.kokoro/samples/python3.7/common.cfg b/packages/google-cloud-language/.kokoro/samples/python3.7/common.cfg
@@ -13,6 +13,12 @@ env_vars: {
     value: "py-3.7"
 }
 
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-py37"
+}
+
 env_vars: {
     key: "TRAMPOLINE_BUILD_FILE"
     value: "github/python-language/.kokoro/test-samples.sh"

diff --git a/packages/google-cloud-language/.kokoro/samples/python3.8/common.cfg b/packages/google-cloud-language/.kokoro/samples/python3.8/common.cfg
@@ -13,6 +13,12 @@ env_vars: {
     value: "py-3.8"
 }
 
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-py38"
+}
+
 env_vars: {
     key: "TRAMPOLINE_BUILD_FILE"
     value: "github/python-language/.kokoro/test-samples.sh"

diff --git a/packages/google-cloud-language/README.rst b/packages/google-cloud-language/README.rst
@@ -62,11 +62,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.
+Unsupported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Python == 2.7. 
+
+The last version of this library compatible with Python 2.7 is google-cloud-language=1.3.0
 
 
 Mac/Linux

diff --git a/packages/google-cloud-language/UPGRADING.md b/packages/google-cloud-language/UPGRADING.md
@@ -0,0 +1,140 @@
+# 2.0.0 Migration Guide
+
+The 2.0 release of the `google-cloud-language` 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-language/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-language
+```
+
+* The script `fixup_language_v1_keywords.py` is shipped with the library. It expects
+an input directory (with the code to convert) and an empty destination directory.
+
+```sh
+$ fixup_language_v1_keywords.py --input-directory .samples/ --output-directory samples/
+```
+
+**Before:**
+```py
+from google.cloud import language_v1
+language = language_v1.LanguageClient()
+return language.analyze_sentiment(document=document).document_sentiment
+```
+
+
+**After:**
+```py
+from google.cloud import language_v1
+language = language_v1.LanguageServiceClient()
+return language.analyze_sentiment(request={'document': document}).document_sentiment
+```
+
+### More Details
+
+In `google-cloud-language<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
+
+**Before:**
+```py
+    def analyze_sentiment(
+        self,
+        document,
+        encoding_type=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 specified by the API producer.
+
+
+**After:**
+```py
+    def analyze_sentiment(
+        self,
+        request: language_service.AnalyzeSentimentRequest = None,
+        *,
+        document: language_service.Document = None,
+        encoding_type: language_service.EncodingType = None,
+        retry: retries.Retry = gapic_v1.method.DEFAULT,
+        timeout: float = None,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> language_service.AnalyzeSentimentResponse:
+```
+
+> **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.analyze_sentiment(
+    request={
+        "document": document,
+        "encoding_type": encoding_type        
+    }
+)
+```
+
+```py
+response = client.analyze_sentiment(
+    document=document, 
+    encoding_type=encoding_type
+    )  # Make an API request.
+```
+
+This call is invalid because it mixes `request` with a keyword argument `entry_group`. Executing this code
+will result in an error.
+
+```py
+response = client.analyze_sentiment(
+    request={
+        "document": document        
+    },
+    encoding_type=encoding_type
+)
+```
+
+
+
+## Enums and Types
+
+
+> **WARNING**: Breaking change
+The submodules `enums` and `types` have been removed.
+**Before:**
+```py
+from google.cloud import language_v1
+document = language_v1.types.Document(content=text, type=language_v1.enums.Document.Type.PLAIN_TEXT)
+encoding_type = language_v1.enums.EncodingType.UTF8
+```
+
+
+**After:**
+```py
+from google.cloud import language_v1
+document = language_v1.Document(content=text, type_=language_v1.Document.Type.PLAIN_TEXT)
+encoding_type = language_v1.EncodingType.UTF8
+```
+
+## Project Path Helper Methods
+
+The project path helper method `project_path` has been removed. Please construct
+this path manually.
+
+```py
+project = 'my-project'
+project_path = f'projects/{project}'
diff --git a/packages/google-cloud-language/docs/UPGRADING.md b/packages/google-cloud-language/docs/UPGRADING.md
@@ -0,0 +1 @@
+../UPGRADING.md
diff --git a/packages/google-cloud-language/docs/api.rst b/packages/google-cloud-language/docs/api.rst
@@ -7,8 +7,8 @@ API. By default, you will get ``v1``, the latest GA version.
 .. toctree::
   :maxdepth: 2
 
-  gapic/v1/api
-  gapic/v1/types
+  language_v1/services
+  language_v1/types
 
 If you are interested in beta features ahead of the latest GA, you may
 opt-in to the v1.1 beta, which is spelled ``v1beta2``. In order to do this,
@@ -20,8 +20,18 @@ An API and type reference is provided for the v1.1 beta also:
 .. toctree::
   :maxdepth: 2
 
-  gapic/v1beta2/api
-  gapic/v1beta2/types
+  language_v1beta2/services
+  language_v1beta2/types
+
+Migration Guide
+---------------
+
+See the guide below for instructions on migrating to the 2.x release of this library.
+
+.. toctree::
+    :maxdepth: 2
+
+    UPGRADING
 
 .. note::
 

diff --git a/packages/google-cloud-language/docs/conf.py b/packages/google-cloud-language/docs/conf.py
@@ -347,7 +347,7 @@
 intersphinx_mapping = {
     "python": ("http://python.readthedocs.org/en/latest/", None),
     "google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
-    "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None),
+    "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,),
     "grpc": ("https://grpc.io/grpc/python/", None),
 }
 

diff --git a/packages/google-cloud-language/docs/gapic/v1/api.rst b/packages/google-cloud-language/docs/gapic/v1/api.rst
diff --git a/packages/google-cloud-language/docs/gapic/v1/types.rst b/packages/google-cloud-language/docs/gapic/v1/types.rst
diff --git a/packages/google-cloud-language/docs/gapic/v1beta2/api.rst b/packages/google-cloud-language/docs/gapic/v1beta2/api.rst
diff --git a/packages/google-cloud-language/docs/gapic/v1beta2/types.rst b/packages/google-cloud-language/docs/gapic/v1beta2/types.rst
diff --git a/packages/google-cloud-language/docs/language_v1/services.rst b/packages/google-cloud-language/docs/language_v1/services.rst
@@ -0,0 +1,6 @@
+Services for Google Cloud Language v1 API
+=========================================
+
+.. automodule:: google.cloud.language_v1.services.language_service
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-language/docs/language_v1/types.rst b/packages/google-cloud-language/docs/language_v1/types.rst
@@ -0,0 +1,5 @@
+Types for Google Cloud Language v1 API
+======================================
+
+.. automodule:: google.cloud.language_v1.types
+    :members:
diff --git a/packages/google-cloud-language/docs/language_v1beta2/services.rst b/packages/google-cloud-language/docs/language_v1beta2/services.rst
@@ -0,0 +1,6 @@
+Services for Google Cloud Language v1beta2 API
+==============================================
+
+.. automodule:: google.cloud.language_v1beta2.services.language_service
+    :members:
+    :inherited-members:
diff --git a/packages/google-cloud-language/docs/language_v1beta2/types.rst b/packages/google-cloud-language/docs/language_v1beta2/types.rst
@@ -0,0 +1,5 @@
+Types for Google Cloud Language v1beta2 API
+===========================================
+
+.. automodule:: google.cloud.language_v1beta2.types
+    :members:
diff --git a/packages/google-cloud-language/google/cloud/language/__init__.py b/packages/google-cloud-language/google/cloud/language/__init__.py
@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from google.cloud.language_v1.services.language_service.async_client import (
+    LanguageServiceAsyncClient,
+)
+from google.cloud.language_v1.services.language_service.client import (
+    LanguageServiceClient,
+)
+from google.cloud.language_v1.types.language_service import AnalyzeEntitiesRequest
+from google.cloud.language_v1.types.language_service import AnalyzeEntitiesResponse
+from google.cloud.language_v1.types.language_service import (
+    AnalyzeEntitySentimentRequest,
+)
+from google.cloud.language_v1.types.language_service import (
+    AnalyzeEntitySentimentResponse,
+)
+from google.cloud.language_v1.types.language_service import AnalyzeSentimentRequest
+from google.cloud.language_v1.types.language_service import AnalyzeSentimentResponse
+from google.cloud.language_v1.types.language_service import AnalyzeSyntaxRequest
+from google.cloud.language_v1.types.language_service import AnalyzeSyntaxResponse
+from google.cloud.language_v1.types.language_service import AnnotateTextRequest
+from google.cloud.language_v1.types.language_service import AnnotateTextResponse
+from google.cloud.language_v1.types.language_service import ClassificationCategory
+from google.cloud.language_v1.types.language_service import ClassifyTextRequest
+from google.cloud.language_v1.types.language_service import ClassifyTextResponse
+from google.cloud.language_v1.types.language_service import DependencyEdge
+from google.cloud.language_v1.types.language_service import Document
+from google.cloud.language_v1.types.language_service import EncodingType
+from google.cloud.language_v1.types.language_service import Entity
+from google.cloud.language_v1.types.language_service import EntityMention
+from google.cloud.language_v1.types.language_service import PartOfSpeech
+from google.cloud.language_v1.types.language_service import Sentence
+from google.cloud.language_v1.types.language_service import Sentiment
+from google.cloud.language_v1.types.language_service import TextSpan
+from google.cloud.language_v1.types.language_service import Token
+
+__all__ = (
+    "AnalyzeEntitiesRequest",
+    "AnalyzeEntitiesResponse",
+    "AnalyzeEntitySentimentRequest",
+    "AnalyzeEntitySentimentResponse",
+    "AnalyzeSentimentRequest",
+    "AnalyzeSentimentResponse",
+    "AnalyzeSyntaxRequest",
+    "AnalyzeSyntaxResponse",
+    "AnnotateTextRequest",
+    "AnnotateTextResponse",
+    "ClassificationCategory",
+    "ClassifyTextRequest",
+    "ClassifyTextResponse",
+    "DependencyEdge",
+    "Document",
+    "EncodingType",
+    "Entity",
+    "EntityMention",
+    "LanguageServiceAsyncClient",
+    "LanguageServiceClient",
+    "PartOfSpeech",
+    "Sentence",
+    "Sentiment",
+    "TextSpan",
+    "Token",
+)
diff --git a/packages/google-cloud-language/google/cloud/language/py.typed b/packages/google-cloud-language/google/cloud/language/py.typed
@@ -0,0 +1,2 @@
+# Marker file for PEP 561.
+# The google-cloud-language package uses inline types.