feat!: use microgenerator (#54)

.coveragerc

@@ -17,22 +17,18 @@
 # Generated by synthtool. DO NOT EDIT!
 [run]
 branch = True
-omit =
-  google/cloud/__init__.py
 
 [report]
 fail_under = 100
 show_missing = True
+omit = google/cloud/recommender/__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

UPGRADING.md

@@ -0,0 +1,152 @@
+# 2.0.0 Migration Guide
+
+The 2.0 release of the `google-cloud-recommender` 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-recommender/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-recommender
+```
+
+* The script `fixup_recommender_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_recommender_v1_keywords.py --input-directory .samples/ --output-directory samples/
+```
+
+**Before:**
+```py
+from google.cloud import recommender
+
+client = recommender.RecommenderClient()
+name = client.insight_path('[PROJECT]', '[LOCATION]', '[INSIGHT_TYPE]', '[INSIGHT]')
+etag = "my_etag"
+response = client.mark_insight_accepted(name=name, etag=etag)
+```
+
+
+**After:**
+```py
+from google.cloud import recommender
+
+client = recommender.RecommenderClient()
+name = client.insight_path('[PROJECT]', '[LOCATION]', '[INSIGHT_TYPE]', '[INSIGHT]')
+etag = "my_etag"
+response = client.mark_insight_accepted(request={"name": name, "etag": etag})
+```
+
+### More Details
+
+In `google-cloud-recommender<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.
+
+**Before:**
+```py
+    def mark_insight_accepted(
+        self,
+        name,
+        etag,
+        state_metadata=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/cloud/recommender/v1/recommender_service.proto#L70) specified by the API producer.
+
+
+**After:**
+```py
+    def mark_insight_accepted(
+        self,
+        request: recommender_service.MarkInsightAcceptedRequest = None,
+        *,
+        name: str = None,
+        state_metadata: Sequence[
+            recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry
+        ] = None,
+        etag: str = None,
+        retry: retries.Retry = gapic_v1.method.DEFAULT,
+        timeout: float = None,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> insight.Insight:
+```
+
+> **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.mark_insight_accepted(
+    request={
+        "name": name,
+        "etag": my_etag
+    }
+)
+```
+
+```py
+response = client.mark_insight_accepted(
+    name=name,
+    etag=my_etag
+)
+```
+
+This call is invalid because it mixes `request` with a keyword argument `etag`. Executing this code
+will result in an error.
+
+```py
+response = client.mark_insight_accepted(
+    request={
+        "name": name
+    },
+    etag=my_etag
+)
+```
+
+
+
+## Enums and Types
+
+
+> **WARNING**: Breaking change
+
+The submodules `enums` and `types` have been removed.
+
+**Before:**
+```py
+
+from google.cloud import recommender
+
+insight = recommender.enums.Insight.Category.PERFORMANCE]
+cost_projection = recommender.types.CostProjection()
+```
+
+
+**After:**
+```py
+from google.cloud import recommender
+
+features = recommender.Insight.Category.PERFORMANCE
+cost_projection = recommender.CostProjection()
+```

docs/UPGRADING.md

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

docs/conf.py

@@ -345,10 +345,10 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    "python": ("http://python.readthedocs.org/en/latest/", None),
-    "google-auth": ("https://google-auth.readthedocs.io/en/stable", None),
+    "python": ("https://python.readthedocs.org/en/latest/", None),
+    "google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),
     "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None,),
-    "grpc": ("https://grpc.io/grpc/python/", None),
+    "grpc": ("https://grpc.github.io/grpc/python/", None),
     "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),
 }
 

docs/index.rst

@@ -13,14 +13,25 @@ v1
 .. toctree::
     :maxdepth: 2
 
-    gapic/v1/api
-    gapic/v1/types
+    recommender_v1/services
+    recommender_v1/types
 
 v1beta1
 =======
 
 .. toctree::
     :maxdepth: 2
 
-    gapic/v1beta1/api
-    gapic/v1beta1/types
+    recommender_v1beta1/services
+    recommender_v1beta1/types
+
+
+Migration Guide
+---------------
+
+See the guide below for instructions on migrating to the 2.x release of this library.
+
+.. toctree::
+    :maxdepth: 2
+
+    UPGRADING

docs/recommender_v1/services.rst

@@ -0,0 +1,6 @@
+Services for Google Cloud Recommender v1 API
+============================================
+
+.. automodule:: google.cloud.recommender_v1.services.recommender
+    :members:
+    :inherited-members:

docs/recommender_v1/types.rst

@@ -0,0 +1,6 @@
+Types for Google Cloud Recommender v1 API
+=========================================
+
+.. automodule:: google.cloud.recommender_v1.types
+    :members:
+    :show-inheritance:

docs/recommender_v1beta1/services.rst

@@ -0,0 +1,6 @@
+Services for Google Cloud Recommender v1beta1 API
+=================================================
+
+.. automodule:: google.cloud.recommender_v1beta1.services.recommender
+    :members:
+    :inherited-members:

docs/recommender_v1beta1/types.rst

@@ -0,0 +1,6 @@
+Types for Google Cloud Recommender v1beta1 API
+==============================================
+
+.. automodule:: google.cloud.recommender_v1beta1.types
+    :members:
+    :show-inheritance:

google/cloud/recommender/__init__.py

@@ -0,0 +1,80 @@
+# -*- 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.recommender_v1.services.recommender.async_client import (
+    RecommenderAsyncClient,
+)
+from google.cloud.recommender_v1.services.recommender.client import RecommenderClient
+from google.cloud.recommender_v1.types.insight import Insight
+from google.cloud.recommender_v1.types.insight import InsightStateInfo
+from google.cloud.recommender_v1.types.recommendation import CostProjection
+from google.cloud.recommender_v1.types.recommendation import Impact
+from google.cloud.recommender_v1.types.recommendation import Operation
+from google.cloud.recommender_v1.types.recommendation import OperationGroup
+from google.cloud.recommender_v1.types.recommendation import Recommendation
+from google.cloud.recommender_v1.types.recommendation import RecommendationContent
+from google.cloud.recommender_v1.types.recommendation import RecommendationStateInfo
+from google.cloud.recommender_v1.types.recommendation import ValueMatcher
+from google.cloud.recommender_v1.types.recommender_service import GetInsightRequest
+from google.cloud.recommender_v1.types.recommender_service import (
+    GetRecommendationRequest,
+)
+from google.cloud.recommender_v1.types.recommender_service import ListInsightsRequest
+from google.cloud.recommender_v1.types.recommender_service import ListInsightsResponse
+from google.cloud.recommender_v1.types.recommender_service import (
+    ListRecommendationsRequest,
+)
+from google.cloud.recommender_v1.types.recommender_service import (
+    ListRecommendationsResponse,
+)
+from google.cloud.recommender_v1.types.recommender_service import (
+    MarkInsightAcceptedRequest,
+)
+from google.cloud.recommender_v1.types.recommender_service import (
+    MarkRecommendationClaimedRequest,
+)
+from google.cloud.recommender_v1.types.recommender_service import (
+    MarkRecommendationFailedRequest,
+)
+from google.cloud.recommender_v1.types.recommender_service import (
+    MarkRecommendationSucceededRequest,
+)
+
+__all__ = (
+    "CostProjection",
+    "GetInsightRequest",
+    "GetRecommendationRequest",
+    "Impact",
+    "Insight",
+    "InsightStateInfo",
+    "ListInsightsRequest",
+    "ListInsightsResponse",
+    "ListRecommendationsRequest",
+    "ListRecommendationsResponse",
+    "MarkInsightAcceptedRequest",
+    "MarkRecommendationClaimedRequest",
+    "MarkRecommendationFailedRequest",
+    "MarkRecommendationSucceededRequest",
+    "Operation",
+    "OperationGroup",
+    "Recommendation",
+    "RecommendationContent",
+    "RecommendationStateInfo",
+    "RecommenderAsyncClient",
+    "RecommenderClient",
+    "ValueMatcher",
+)

google/cloud/recommender/py.typed

@@ -0,0 +1,2 @@
+# Marker file for PEP 561.
+# The google-cloud-recommender package uses inline types.