Skip to content
Permalink
Browse files
feat!: use microgenerator (#54)
  • Loading branch information
danoscarmike committed Nov 19, 2020
1 parent 8538b29 commit 63b8a43ce25a5305664424fa247ad82595c4342f
Showing with 16,256 additions and 12,885 deletions.
  1. +6 −10 .coveragerc
  2. +152 −0 UPGRADING.md
  3. +1 −0 docs/UPGRADING.md
  4. +3 −3 docs/conf.py
  5. +0 −6 docs/gapic/v1/api.rst
  6. +0 −5 docs/gapic/v1/types.rst
  7. +0 −6 docs/gapic/v1beta1/api.rst
  8. +0 −5 docs/gapic/v1beta1/types.rst
  9. +15 −4 docs/index.rst
  10. +6 −0 docs/recommender_v1/services.rst
  11. +6 −0 docs/recommender_v1/types.rst
  12. +6 −0 docs/recommender_v1beta1/services.rst
  13. +6 −0 docs/recommender_v1beta1/types.rst
  14. +80 −0 google/cloud/recommender/__init__.py
  15. +2 −0 google/cloud/recommender/py.typed
  16. +44 −26 google/cloud/recommender_v1/__init__.py
  17. 0 google/cloud/recommender_v1/gapic/__init__.py
  18. +0 −134 google/cloud/recommender_v1/gapic/enums.py
  19. +0 −970 google/cloud/recommender_v1/gapic/recommender_client.py
  20. +0 −82 google/cloud/recommender_v1/gapic/recommender_client_config.py
  21. 0 google/cloud/recommender_v1/gapic/transports/__init__.py
  22. +0 −251 google/cloud/recommender_v1/gapic/transports/recommender_grpc_transport.py
  23. 0 google/cloud/recommender_v1/proto/__init__.py
  24. +0 −666 google/cloud/recommender_v1/proto/insight_pb2.py
  25. +0 −3 google/cloud/recommender_v1/proto/insight_pb2_grpc.py
  26. +0 −1,525 google/cloud/recommender_v1/proto/recommendation_pb2.py
  27. +0 −3 google/cloud/recommender_v1/proto/recommendation_pb2_grpc.py
  28. +0 −1,471 google/cloud/recommender_v1/proto/recommender_service_pb2.py
  29. +0 −460 google/cloud/recommender_v1/proto/recommender_service_pb2_grpc.py
  30. +2 −0 google/cloud/recommender_v1/py.typed
  31. +3 −16 google/cloud/{recommender.py → recommender_v1/services/__init__.py}
  32. +9 −9 google/{ → cloud/recommender_v1/services/recommender}/__init__.py
  33. +957 −0 google/cloud/recommender_v1/services/recommender/async_client.py
  34. +1,186 −0 google/cloud/recommender_v1/services/recommender/client.py
  35. +282 −0 google/cloud/recommender_v1/services/recommender/pagers.py
  36. +36 −0 google/cloud/recommender_v1/services/recommender/transports/__init__.py
  37. +276 −0 google/cloud/recommender_v1/services/recommender/transports/base.py
  38. +508 −0 google/cloud/recommender_v1/services/recommender/transports/grpc.py
  39. +515 −0 google/cloud/recommender_v1/services/recommender/transports/grpc_asyncio.py
  40. +0 −58 google/cloud/recommender_v1/types.py
  41. +67 −0 google/cloud/recommender_v1/types/__init__.py
  42. +140 −0 google/cloud/recommender_v1/types/insight.py
  43. +353 −0 google/cloud/recommender_v1/types/recommendation.py
  44. +278 −0 google/cloud/recommender_v1/types/recommender_service.py
  45. +44 −26 google/cloud/recommender_v1beta1/__init__.py
  46. 0 google/cloud/recommender_v1beta1/gapic/__init__.py
  47. +0 −134 google/cloud/recommender_v1beta1/gapic/enums.py
  48. +0 −970 google/cloud/recommender_v1beta1/gapic/recommender_client.py
  49. +0 −82 google/cloud/recommender_v1beta1/gapic/recommender_client_config.py
  50. 0 google/cloud/recommender_v1beta1/gapic/transports/__init__.py
  51. +0 −251 google/cloud/recommender_v1beta1/gapic/transports/recommender_grpc_transport.py
  52. 0 google/cloud/recommender_v1beta1/proto/__init__.py
  53. +0 −666 google/cloud/recommender_v1beta1/proto/insight_pb2.py
  54. +0 −3 google/cloud/recommender_v1beta1/proto/insight_pb2_grpc.py
  55. +0 −234 google/cloud/recommender_v1beta1/proto/recommendation.proto
  56. +0 −1,525 google/cloud/recommender_v1beta1/proto/recommendation_pb2.py
  57. +0 −3 google/cloud/recommender_v1beta1/proto/recommendation_pb2_grpc.py
  58. +0 −190 google/cloud/recommender_v1beta1/proto/recommender_service.proto
  59. +0 −1,471 google/cloud/recommender_v1beta1/proto/recommender_service_pb2.py
  60. +0 −460 google/cloud/recommender_v1beta1/proto/recommender_service_pb2_grpc.py
  61. +2 −0 google/cloud/recommender_v1beta1/py.typed
  62. +16 −0 google/cloud/recommender_v1beta1/services/__init__.py
  63. +9 −9 google/cloud/{ → recommender_v1beta1/services/recommender}/__init__.py
  64. +957 −0 google/cloud/recommender_v1beta1/services/recommender/async_client.py
  65. +1,186 −0 google/cloud/recommender_v1beta1/services/recommender/client.py
  66. +282 −0 google/cloud/recommender_v1beta1/services/recommender/pagers.py
  67. +36 −0 google/cloud/recommender_v1beta1/services/recommender/transports/__init__.py
  68. +276 −0 google/cloud/recommender_v1beta1/services/recommender/transports/base.py
  69. +508 −0 google/cloud/recommender_v1beta1/services/recommender/transports/grpc.py
  70. +515 −0 google/cloud/recommender_v1beta1/services/recommender/transports/grpc_asyncio.py
  71. +0 −58 google/cloud/recommender_v1beta1/types.py
  72. +67 −0 google/cloud/recommender_v1beta1/types/__init__.py
  73. +141 −0 google/cloud/recommender_v1beta1/types/insight.py
  74. +353 −0 google/cloud/recommender_v1beta1/types/recommendation.py
  75. +278 −0 google/cloud/recommender_v1beta1/types/recommender_service.py
  76. +1 −1 mypy.ini
  77. +5 −3 noxfile.py
  78. +1 −0 samples/AUTHORING_GUIDE.md
  79. +1 −0 samples/CONTRIBUTING.md
  80. +186 −0 scripts/fixup_recommender_v1_keywords.py
  81. +186 −0 scripts/fixup_recommender_v1beta1_keywords.py
  82. +13 −4 setup.py
  83. +6 −111 synth.metadata
  84. +16 −23 synth.py
  85. +1 −0 tests/unit/gapic/recommender_v1/__init__.py
  86. +3,115 −0 tests/unit/gapic/recommender_v1/test_recommender.py
  87. +1 −0 tests/unit/gapic/recommender_v1beta1/__init__.py
  88. +3,115 −0 tests/unit/gapic/recommender_v1beta1/test_recommender.py
  89. +0 −474 tests/unit/gapic/v1/test_recommender_client_v1.py
  90. +0 −474 tests/unit/gapic/v1beta1/test_recommender_client_v1beta1.py
@@ -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
@@ -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()
```
@@ -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),
}

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

@@ -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
@@ -0,0 +1,6 @@
Services for Google Cloud Recommender v1 API
============================================

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

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

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

.. automodule:: google.cloud.recommender_v1beta1.types
:members:
:show-inheritance:
@@ -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",
)
@@ -0,0 +1,2 @@
# Marker file for PEP 561.
# The google-cloud-recommender package uses inline types.

0 comments on commit 63b8a43

Please sign in to comment.