From d0bb68002fc899c69fe9a2b01199da0a3bb8149f Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 5 Aug 2025 13:07:08 +0000 Subject: [PATCH 1/2] feat: add ordertracking API client libraries for v1 PiperOrigin-RevId: 791137429 Source-Link: https://github.com/googleapis/googleapis/commit/438200a688c81b759c38747423079c2e1fab9dd9 Source-Link: https://github.com/googleapis/googleapis-gen/commit/ad9a83a608b63d84f139b579948a609f6856db91 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLXNob3BwaW5nLW1lcmNoYW50LW9yZGVydHJhY2tpbmcvLk93bEJvdC55YW1sIiwiaCI6ImFkOWE4M2E2MDhiNjNkODRmMTM5YjU3OTk0OGE2MDlmNjg1NmRiOTEifQ== --- .../v1/.coveragerc | 13 + .../v1/.flake8 | 34 + .../v1/LICENSE | 202 ++ .../v1/MANIFEST.in | 20 + .../v1/README.rst | 143 ++ .../v1/docs/_static/custom.css | 20 + .../v1/docs/_templates/layout.html | 50 + .../v1/docs/conf.py | 385 +++ .../v1/docs/index.rst | 10 + .../order_tracking_signals_service.rst | 6 + .../merchant_ordertracking_v1/services_.rst | 6 + .../docs/merchant_ordertracking_v1/types_.rst | 6 + .../v1/docs/multiprocessing.rst | 7 + .../merchant_ordertracking/__init__.py | 31 + .../merchant_ordertracking/gapic_version.py | 16 + .../shopping/merchant_ordertracking/py.typed | 2 + .../merchant_ordertracking_v1/__init__.py | 32 + .../gapic_metadata.json | 43 + .../gapic_version.py | 16 + .../merchant_ordertracking_v1/py.typed | 2 + .../services/__init__.py | 15 + .../__init__.py | 22 + .../async_client.py | 396 +++ .../order_tracking_signals_service/client.py | 756 ++++++ .../transports/README.rst | 9 + .../transports/__init__.py | 38 + .../transports/base.py | 159 ++ .../transports/grpc.py | 346 +++ .../transports/grpc_asyncio.py | 367 +++ .../transports/rest.py | 361 +++ .../transports/rest_base.py | 138 + .../types/__init__.py | 24 + .../types/order_tracking_signals.py | 375 +++ .../v1/mypy.ini | 3 + .../v1/noxfile.py | 591 +++++ ...vice_create_order_tracking_signal_async.py | 63 + ...rvice_create_order_tracking_signal_sync.py | 63 + ...le.shopping.merchant.ordertracking.v1.json | 184 ++ ...ixup_merchant_ordertracking_v1_keywords.py | 176 ++ .../v1/setup.py | 99 + .../v1/testing/constraints-3.10.txt | 7 + .../v1/testing/constraints-3.11.txt | 7 + .../v1/testing/constraints-3.12.txt | 7 + .../v1/testing/constraints-3.13.txt | 12 + .../v1/testing/constraints-3.7.txt | 11 + .../v1/testing/constraints-3.8.txt | 7 + .../v1/testing/constraints-3.9.txt | 7 + .../v1/tests/__init__.py | 16 + .../v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../merchant_ordertracking_v1/__init__.py | 16 + .../test_order_tracking_signals_service.py | 2243 +++++++++++++++++ .../v1beta/.coveragerc | 13 + .../v1beta/.flake8 | 34 + .../v1beta/LICENSE | 202 ++ .../v1beta/MANIFEST.in | 20 + .../v1beta/README.rst | 143 ++ .../v1beta/docs/_static/custom.css | 20 + .../v1beta/docs/_templates/layout.html | 50 + .../v1beta/docs/conf.py | 385 +++ .../v1beta/docs/index.rst | 10 + .../order_tracking_signals_service.rst | 6 + .../services_.rst | 6 + .../merchant_ordertracking_v1beta/types_.rst | 6 + .../v1beta/docs/multiprocessing.rst | 7 + .../merchant_ordertracking/__init__.py | 31 + .../merchant_ordertracking/gapic_version.py | 16 + .../shopping/merchant_ordertracking/py.typed | 2 + .../merchant_ordertracking_v1beta/__init__.py | 32 + .../gapic_metadata.json | 43 + .../gapic_version.py | 16 + .../merchant_ordertracking_v1beta/py.typed | 2 + .../services/__init__.py | 15 + .../__init__.py | 22 + .../async_client.py | 396 +++ .../order_tracking_signals_service/client.py | 756 ++++++ .../transports/README.rst | 9 + .../transports/__init__.py | 38 + .../transports/base.py | 159 ++ .../transports/grpc.py | 346 +++ .../transports/grpc_asyncio.py | 367 +++ .../transports/rest.py | 361 +++ .../transports/rest_base.py | 138 + .../types/__init__.py | 24 + .../types/order_tracking_signals.py | 375 +++ .../v1beta/mypy.ini | 3 + .../v1beta/noxfile.py | 591 +++++ ...vice_create_order_tracking_signal_async.py | 63 + ...rvice_create_order_tracking_signal_sync.py | 63 + ...hopping.merchant.ordertracking.v1beta.json | 184 ++ ..._merchant_ordertracking_v1beta_keywords.py | 176 ++ .../v1beta/setup.py | 99 + .../v1beta/testing/constraints-3.10.txt | 7 + .../v1beta/testing/constraints-3.11.txt | 7 + .../v1beta/testing/constraints-3.12.txt | 7 + .../v1beta/testing/constraints-3.13.txt | 12 + .../v1beta/testing/constraints-3.7.txt | 11 + .../v1beta/testing/constraints-3.8.txt | 7 + .../v1beta/testing/constraints-3.9.txt | 7 + .../v1beta/tests/__init__.py | 16 + .../v1beta/tests/unit/__init__.py | 16 + .../v1beta/tests/unit/gapic/__init__.py | 16 + .../merchant_ordertracking_v1beta/__init__.py | 16 + .../test_order_tracking_signals_service.py | 2243 +++++++++++++++++ 104 files changed, 15188 insertions(+) create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py create mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc new file mode 100644 index 000000000000..c02611dc5807 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/shopping/merchant_ordertracking/__init__.py + google/shopping/merchant_ordertracking/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 new file mode 100644 index 000000000000..90316de21489 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +[flake8] +# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): +# Resolve flake8 lint issues +ignore = E203, E231, E266, E501, W503 +exclude = + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): + # Ensure that generated code passes flake8 lint + **/gapic/** + **/services/** + **/types/** + # Exclude Protobuf gencode + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE new file mode 100644 index 000000000000..d64569567334 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in new file mode 100644 index 000000000000..dae249ec8976 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +include README.rst LICENSE +recursive-include google *.py *.pyi *.json *.proto py.typed +recursive-include tests * +global-exclude *.py[co] +global-exclude __pycache__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst new file mode 100644 index 000000000000..c4e23cfbdc21 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst @@ -0,0 +1,143 @@ +Python Client for Google Shopping Merchant Ordertracking API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Shopping Merchant Ordertracking API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library + + +Logging +------- + +This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. +Note the following: + +#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. +#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. +#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. + + +Simple, environment-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google +logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged +messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging +event. + +A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. + +- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. +- Invalid logging scopes: :code:`foo`, :code:`123`, etc. + +**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. + + +Examples +^^^^^^^^ + +- Enabling the default handler for all Google-based loggers + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google + +- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 + + +Advanced, code-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can also configure a valid logging scope using Python's standard `logging` mechanism. + + +Examples +^^^^^^^^ + +- Configuring a handler for all Google-based loggers + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + +- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google.cloud.library_v1") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + + +Logging details +~~~~~~~~~~~~~~~ + +#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root + logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set + :code:`logging.getLogger("google").propagate = True` in your code. +#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for + one library, but decide you need to also set up environment-based logging configuration for another library. + + #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual + if the code -based configuration gets applied first. + +#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get + executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. + (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css new file mode 100644 index 000000000000..b0a295464b23 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css @@ -0,0 +1,20 @@ +div#python2-eol { + border-color: red; + border-width: medium; +} + +/* Ensure minimum width for 'Parameters' / 'Returns' column */ +dl.field-list > dt { + min-width: 100px +} + +/* Insert space between methods for readability */ +dl.method { + padding-top: 10px; + padding-bottom: 10px +} + +/* Insert empty space between classes */ +dl.class { + padding-bottom: 50px +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html new file mode 100644 index 000000000000..95e9c77fcfe1 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html @@ -0,0 +1,50 @@ + +{% extends "!layout.html" %} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +
+ {{ sidebar() }} + {%- block document %} +
+ {%- if render_sidebar %} +
+ {%- endif %} + + {%- block relbar_top %} + {%- if theme_show_relbar_top|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + +
+
+ As of January 1, 2020 this library no longer supports Python 2 on the latest released version. + Library versions released prior to that date will continue to be available. For more information please + visit Python 2 support on Google Cloud. +
+ {% block body %} {% endblock %} +
+ + {%- block relbar_bottom %} + {%- if theme_show_relbar_bottom|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + + {%- if render_sidebar %} +
+ {%- endif %} +
+ {%- endblock %} +
+
+{%- else %} +{{ super() }} +{%- endif %} +{%- endblock %} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py new file mode 100644 index 000000000000..7a8d49f67478 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py @@ -0,0 +1,385 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# +# google-shopping-merchant-ordertracking documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +# For plugins that can not read conf.py. +# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 +sys.path.insert(0, os.path.abspath(".")) + +__version__ = "" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.5.0" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.doctest", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "recommonmark", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_options = {"members": True} +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-shopping-merchant-ordertracking" +copyright = u"2025, Google, LLC" +author = u"Google APIs" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [ + "_build", + "**/.nox/**/*", + "samples/AUTHORING_GUIDE.md", + "samples/CONTRIBUTING.md", + "samples/snippets/README.rst", +] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Shopping Client Libraries for google-shopping-merchant-ordertracking", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-shopping-merchant-ordertracking-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-shopping-merchant-ordertracking.tex", + u"google-shopping-merchant-ordertracking Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Documentation", + author, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Library", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "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.github.io/grpc/python/", None), + "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst new file mode 100644 index 000000000000..6d1e4e37544c --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst @@ -0,0 +1,10 @@ +.. include:: multiprocessing.rst + + +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_ordertracking_v1/services_ + merchant_ordertracking_v1/types_ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst new file mode 100644 index 000000000000..8346bf46f7cf --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst @@ -0,0 +1,6 @@ +OrderTrackingSignalsService +--------------------------------------------- + +.. automodule:: google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service + :members: + :inherited-members: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst new file mode 100644 index 000000000000..682e079c7c2a --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Shopping Merchant Ordertracking v1 API +========================================================== +.. toctree:: + :maxdepth: 2 + + order_tracking_signals_service diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst new file mode 100644 index 000000000000..84bf38a3704f --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Ordertracking v1 API +======================================================= + +.. automodule:: google.shopping.merchant_ordertracking_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst new file mode 100644 index 000000000000..536d17b2ea65 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst @@ -0,0 +1,7 @@ +.. note:: + + Because this client uses :mod:`grpc` library, it is safe to + share instances across threads. In multiprocessing scenarios, the best + practice is to create client instances *after* the invocation of + :func:`os.fork` by :class:`multiprocessing.pool.Pool` or + :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py new file mode 100644 index 000000000000..0727b57c595e --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.shopping.merchant_ordertracking import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.client import OrderTrackingSignalsServiceClient +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.async_client import OrderTrackingSignalsServiceAsyncClient + +from google.shopping.merchant_ordertracking_v1.types.order_tracking_signals import CreateOrderTrackingSignalRequest +from google.shopping.merchant_ordertracking_v1.types.order_tracking_signals import OrderTrackingSignal + +__all__ = ('OrderTrackingSignalsServiceClient', + 'OrderTrackingSignalsServiceAsyncClient', + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed new file mode 100644 index 000000000000..24d3a8286bc4 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py new file mode 100644 index 000000000000..53765b98bfc9 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.shopping.merchant_ordertracking_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.order_tracking_signals_service import OrderTrackingSignalsServiceClient +from .services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient + +from .types.order_tracking_signals import CreateOrderTrackingSignalRequest +from .types.order_tracking_signals import OrderTrackingSignal + +__all__ = ( + 'OrderTrackingSignalsServiceAsyncClient', +'CreateOrderTrackingSignalRequest', +'OrderTrackingSignal', +'OrderTrackingSignalsServiceClient', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json new file mode 100644 index 000000000000..98e4d4a7d28b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json @@ -0,0 +1,43 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_ordertracking_v1", + "protoPackage": "google.shopping.merchant.ordertracking.v1", + "schema": "1.0", + "services": { + "OrderTrackingSignalsService": { + "clients": { + "grpc": { + "libraryClient": "OrderTrackingSignalsServiceClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + }, + "grpc-async": { + "libraryClient": "OrderTrackingSignalsServiceAsyncClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + }, + "rest": { + "libraryClient": "OrderTrackingSignalsServiceClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed new file mode 100644 index 000000000000..24d3a8286bc4 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py new file mode 100644 index 000000000000..15b29929ccad --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 .client import OrderTrackingSignalsServiceClient +from .async_client import OrderTrackingSignalsServiceAsyncClient + +__all__ = ( + 'OrderTrackingSignalsServiceClient', + 'OrderTrackingSignalsServiceAsyncClient', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py new file mode 100644 index 000000000000..ba5e06133757 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py @@ -0,0 +1,396 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import logging as std_logging +from collections import OrderedDict +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .client import OrderTrackingSignalsServiceClient + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +class OrderTrackingSignalsServiceAsyncClient: + """Service to serve order tracking signals public API.""" + + _client: OrderTrackingSignalsServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + + account_path = staticmethod(OrderTrackingSignalsServiceClient.account_path) + parse_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_account_path) + common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_organization_path) + common_project_path = staticmethod(OrderTrackingSignalsServiceClient.common_project_path) + parse_common_project_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_project_path) + common_location_path = staticmethod(OrderTrackingSignalsServiceClient.common_location_path) + parse_common_location_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceAsyncClient: The constructed client. + """ + return OrderTrackingSignalsServiceClient.from_service_account_info.__func__(OrderTrackingSignalsServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceAsyncClient: The constructed client. + """ + return OrderTrackingSignalsServiceClient.from_service_account_file.__func__(OrderTrackingSignalsServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return OrderTrackingSignalsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> OrderTrackingSignalsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OrderTrackingSignalsServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = OrderTrackingSignalsServiceClient.get_transport_class + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the order tracking signals service async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OrderTrackingSignalsServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = OrderTrackingSignalsServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceAsyncClient`.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._client._transport, "_credentials") else { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "credentialsType": None, + } + ) + + async def create_order_tracking_signal(self, + request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Creates new order tracking signal. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_ordertracking_v1 + + async def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1.OrderTrackingSignalsServiceAsyncClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = await client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_ordertracking_v1.types.CreateOrderTrackingSignalRequest, dict]]): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + parent (:class:`str`): + Required. The account of the business + for which the order signal is created. + Format: accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + order_tracking_signal_id (:class:`str`): + Output only. The ID that uniquely + identifies this order tracking signal. + + This corresponds to the ``order_tracking_signal_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent, order_tracking_signal_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if order_tracking_signal_id is not None: + request.order_tracking_signal_id = order_tracking_signal_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_order_tracking_signal] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "OrderTrackingSignalsServiceAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ( + "OrderTrackingSignalsServiceAsyncClient", +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py new file mode 100644 index 000000000000..6ca9cd9cf31d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py @@ -0,0 +1,756 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 collections import OrderedDict +from http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +import warnings + +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import OrderTrackingSignalsServiceGrpcTransport +from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .transports.rest import OrderTrackingSignalsServiceRestTransport + + +class OrderTrackingSignalsServiceClientMeta(type): + """Metaclass for the OrderTrackingSignalsService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] + _transport_registry["grpc"] = OrderTrackingSignalsServiceGrpcTransport + _transport_registry["grpc_asyncio"] = OrderTrackingSignalsServiceGrpcAsyncIOTransport + _transport_registry["rest"] = OrderTrackingSignalsServiceRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[OrderTrackingSignalsServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class OrderTrackingSignalsServiceClient(metaclass=OrderTrackingSignalsServiceClientMeta): + """Service to serve order tracking signals public API.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> OrderTrackingSignalsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OrderTrackingSignalsServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def account_path(account: str,) -> str: + """Returns a fully-qualified account string.""" + return "accounts/{account}".format(account=account, ) + + @staticmethod + def parse_account_path(path: str) -> Dict[str,str]: + """Parses a account path into its component segments.""" + m = re.match(r"^accounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + _default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + api_endpoint = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + return api_endpoint + + @staticmethod + def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, + error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the order tracking signals service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OrderTrackingSignalsServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + + universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + + self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OrderTrackingSignalsServiceClient._read_environment_variables() + self._client_cert_source = OrderTrackingSignalsServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) + self._universe_domain = OrderTrackingSignalsServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance(transport, OrderTrackingSignalsServiceTransport) + if transport_provided: + # transport is a OrderTrackingSignalsServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(OrderTrackingSignalsServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = (self._api_endpoint or + OrderTrackingSignalsServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint)) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + transport_init: Union[Type[OrderTrackingSignalsServiceTransport], Callable[..., OrderTrackingSignalsServiceTransport]] = ( + OrderTrackingSignalsServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., OrderTrackingSignalsServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient`.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._transport, "_credentials") else { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "credentialsType": None, + } + ) + + def create_order_tracking_signal(self, + request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Creates new order tracking signal. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_ordertracking_v1 + + def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1.OrderTrackingSignalsServiceClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_ordertracking_v1.types.CreateOrderTrackingSignalRequest, dict]): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + parent (str): + Required. The account of the business + for which the order signal is created. + Format: accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + order_tracking_signal_id (str): + Output only. The ID that uniquely + identifies this order tracking signal. + + This corresponds to the ``order_tracking_signal_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent, order_tracking_signal_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if order_tracking_signal_id is not None: + request.order_tracking_signal_id = order_tracking_signal_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_order_tracking_signal] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "OrderTrackingSignalsServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ( + "OrderTrackingSignalsServiceClient", +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst new file mode 100644 index 000000000000..4c596b6640df --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`OrderTrackingSignalsServiceTransport` is the ABC for all transports. +- public child `OrderTrackingSignalsServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `OrderTrackingSignalsServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseOrderTrackingSignalsServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `OrderTrackingSignalsServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py new file mode 100644 index 000000000000..c1246dfdc064 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 collections import OrderedDict +from typing import Dict, Type + +from .base import OrderTrackingSignalsServiceTransport +from .grpc import OrderTrackingSignalsServiceGrpcTransport +from .grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .rest import OrderTrackingSignalsServiceRestTransport +from .rest import OrderTrackingSignalsServiceRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] +_transport_registry['grpc'] = OrderTrackingSignalsServiceGrpcTransport +_transport_registry['grpc_asyncio'] = OrderTrackingSignalsServiceGrpcAsyncIOTransport +_transport_registry['rest'] = OrderTrackingSignalsServiceRestTransport + +__all__ = ( + 'OrderTrackingSignalsServiceTransport', + 'OrderTrackingSignalsServiceGrpcTransport', + 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', + 'OrderTrackingSignalsServiceRestTransport', + 'OrderTrackingSignalsServiceRestInterceptor', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py new file mode 100644 index 000000000000..1bcd7198776c --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py @@ -0,0 +1,159 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class OrderTrackingSignalsServiceTransport(abc.ABC): + """Abstract transport class for OrderTrackingSignalsService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/content', + ) + + DEFAULT_HOST: str = 'merchantapi.googleapis.com' + + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_order_tracking_signal: gapic_v1.method.wrap_method( + self.create_order_tracking_signal, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Union[ + order_tracking_signals.OrderTrackingSignal, + Awaitable[order_tracking_signals.OrderTrackingSignal] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'OrderTrackingSignalsServiceTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py new file mode 100644 index 000000000000..18c853e994e0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py @@ -0,0 +1,346 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import json +import logging as std_logging +import pickle +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class OrderTrackingSignalsServiceGrpcTransport(OrderTrackingSignalsServiceTransport): + """gRPC backend transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal]: + r"""Return a callable for the create order tracking signal method over gRPC. + + Creates new order tracking signal. + + Returns: + Callable[[~.CreateOrderTrackingSignalRequest], + ~.OrderTrackingSignal]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_order_tracking_signal' not in self._stubs: + self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( + '/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal', + request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, + response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, + ) + return self._stubs['create_order_tracking_signal'] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'OrderTrackingSignalsServiceGrpcTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..50a5069c56fc --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py @@ -0,0 +1,367 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import inspect +import json +import pickle +import logging as std_logging +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import exceptions as core_exceptions +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore +from grpc.experimental import aio # type: ignore + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import OrderTrackingSignalsServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class OrderTrackingSignalsServiceGrpcAsyncIOTransport(OrderTrackingSignalsServiceTransport): + """gRPC AsyncIO backend transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Awaitable[order_tracking_signals.OrderTrackingSignal]]: + r"""Return a callable for the create order tracking signal method over gRPC. + + Creates new order tracking signal. + + Returns: + Callable[[~.CreateOrderTrackingSignalRequest], + Awaitable[~.OrderTrackingSignal]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_order_tracking_signal' not in self._stubs: + self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( + '/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal', + request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, + response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, + ) + return self._stubs['create_order_tracking_signal'] + + def _prep_wrapped_messages(self, client_info): + """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.create_order_tracking_signal: self._wrap_method( + self.create_order_tracking_signal, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ( + 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py new file mode 100644 index 000000000000..95be32929e80 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py @@ -0,0 +1,361 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import logging +import json # type: ignore + +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import gapic_v1 +import google.protobuf + +from google.protobuf import json_format + +from requests import __version__ as requests_version +import dataclasses +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals + + +from .rest_base import _BaseOrderTrackingSignalsServiceRestTransport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class OrderTrackingSignalsServiceRestInterceptor: + """Interceptor for OrderTrackingSignalsService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the OrderTrackingSignalsServiceRestTransport. + + .. code-block:: python + class MyCustomOrderTrackingSignalsServiceInterceptor(OrderTrackingSignalsServiceRestInterceptor): + def pre_create_order_tracking_signal(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_order_tracking_signal(self, response): + logging.log(f"Received response: {response}") + return response + + transport = OrderTrackingSignalsServiceRestTransport(interceptor=MyCustomOrderTrackingSignalsServiceInterceptor()) + client = OrderTrackingSignalsServiceClient(transport=transport) + + + """ + def pre_create_order_tracking_signal(self, request: order_tracking_signals.CreateOrderTrackingSignalRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.CreateOrderTrackingSignalRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_order_tracking_signal + + Override in a subclass to manipulate the request or metadata + before they are sent to the OrderTrackingSignalsService server. + """ + return request, metadata + + def post_create_order_tracking_signal(self, response: order_tracking_signals.OrderTrackingSignal) -> order_tracking_signals.OrderTrackingSignal: + """Post-rpc interceptor for create_order_tracking_signal + + DEPRECATED. Please use the `post_create_order_tracking_signal_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the OrderTrackingSignalsService server but before + it is returned to user code. This `post_create_order_tracking_signal` interceptor runs + before the `post_create_order_tracking_signal_with_metadata` interceptor. + """ + return response + + def post_create_order_tracking_signal_with_metadata(self, response: order_tracking_signals.OrderTrackingSignal, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.OrderTrackingSignal, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_order_tracking_signal + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the OrderTrackingSignalsService server but before it is returned to user code. + + We recommend only using this `post_create_order_tracking_signal_with_metadata` + interceptor in new development instead of the `post_create_order_tracking_signal` interceptor. + When both interceptors are used, this `post_create_order_tracking_signal_with_metadata` interceptor runs after the + `post_create_order_tracking_signal` interceptor. The (possibly modified) response returned by + `post_create_order_tracking_signal` will be passed to + `post_create_order_tracking_signal_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class OrderTrackingSignalsServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: OrderTrackingSignalsServiceRestInterceptor + + +class OrderTrackingSignalsServiceRestTransport(_BaseOrderTrackingSignalsServiceRestTransport): + """REST backend synchronous transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[OrderTrackingSignalsServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or OrderTrackingSignalsServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateOrderTrackingSignal(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal, OrderTrackingSignalsServiceRestStub): + def __hash__(self): + return hash("OrderTrackingSignalsServiceRestTransport.CreateOrderTrackingSignal") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: order_tracking_signals.CreateOrderTrackingSignalRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Call the create order tracking + signal method over HTTP. + + Args: + request (~.order_tracking_signals.CreateOrderTrackingSignalRequest): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.order_tracking_signals.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + + http_options = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_http_options() + + request, metadata = self._interceptor.pre_create_order_tracking_signal(request, metadata) + transcoded_request = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_transcoded_request(http_options, request) + + body = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient.CreateOrderTrackingSignal", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": "CreateOrderTrackingSignal", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = OrderTrackingSignalsServiceRestTransport._CreateOrderTrackingSignal._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, body) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = order_tracking_signals.OrderTrackingSignal() + pb_resp = order_tracking_signals.OrderTrackingSignal.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_order_tracking_signal(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_order_tracking_signal_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = order_tracking_signals.OrderTrackingSignal.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient.create_order_tracking_signal", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "rpcName": "CreateOrderTrackingSignal", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateOrderTrackingSignal(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'OrderTrackingSignalsServiceRestTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py new file mode 100644 index 000000000000..9fbf716ff82e --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py @@ -0,0 +1,138 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import json # type: ignore +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals + + +class _BaseOrderTrackingSignalsServiceRestTransport(OrderTrackingSignalsServiceTransport): + """Base REST backend transport for OrderTrackingSignalsService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[Any]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + + class _BaseCreateOrderTrackingSignal: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals', + 'body': 'order_tracking_signal', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__=( + '_BaseOrderTrackingSignalsServiceRestTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py new file mode 100644 index 000000000000..d1e7569d2768 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py @@ -0,0 +1,24 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 .order_tracking_signals import ( + CreateOrderTrackingSignalRequest, + OrderTrackingSignal, +) + +__all__ = ( + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py new file mode 100644 index 000000000000..d5378e80ce35 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py @@ -0,0 +1,375 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.shopping.merchant.ordertracking.v1', + manifest={ + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', + }, +) + + +class CreateOrderTrackingSignalRequest(proto.Message): + r"""Signals only can be created but not updated. + Businesses need to call this API only when the order is + completely shipped. Creates new order signal. + + Attributes: + parent (str): + Required. The account of the business for + which the order signal is created. Format: + accounts/{account} + order_tracking_signal_id (str): + Output only. The ID that uniquely identifies + this order tracking signal. + order_tracking_signal (google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal): + Required. The order signal to be created. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + order_tracking_signal_id: str = proto.Field( + proto.STRING, + number=2, + ) + order_tracking_signal: 'OrderTrackingSignal' = proto.Field( + proto.MESSAGE, + number=3, + message='OrderTrackingSignal', + ) + + +class OrderTrackingSignal(proto.Message): + r"""Represents a business trade from which signals are extracted, + such as shipping. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + order_tracking_signal_id (int): + Output only. The ID that uniquely identifies + this order tracking signal. + merchant_id (int): + Optional. The Google Merchant Center ID of this order + tracking signal. This value is optional. If left unset, the + caller's Merchant Center ID is used. You must request access + in order to provide data on behalf of another business. For + more information, see `Submitting Order Tracking + Signals `__. + order_created_time (google.type.datetime_pb2.DateTime): + Required. The time when the order was created + on the businesses side. Include the year and + timezone string, if available. + order_id (str): + Required. The ID of the order on the + businesses side. This field will be hashed in + returned OrderTrackingSignal creation response. + shipping_info (MutableSequence[google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal.ShippingInfo]): + Required. The shipping information for the + order. + line_items (MutableSequence[google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal.LineItemDetails]): + Required. Information about line items in the + order. + shipment_line_item_mapping (MutableSequence[google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal.ShipmentLineItemMapping]): + Optional. The mapping of the line items to + the shipment information. + customer_shipping_fee (google.shopping.type.types.Price): + Optional. The shipping fee of the order; + this value should be set to zero in the case of + free shipping. + + This field is a member of `oneof`_ ``_customer_shipping_fee``. + delivery_postal_code (str): + Optional. The delivery postal code, as a + continuous string without spaces or dashes, for + example "95016". This field will be anonymized + in returned OrderTrackingSignal creation + response. + delivery_region_code (str): + Optional. The [CLDR territory code] + (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + for the shipping destination. + """ + + class ShippingInfo(proto.Message): + r"""The shipping information for the order. + + Attributes: + shipment_id (str): + Required. The shipment ID. This field will be + hashed in returned OrderTrackingSignal creation + response. + tracking_id (str): + Optional. The tracking ID of the shipment. This field is + required if one of the following fields is absent: + earliest_delivery_promise_time, + latest_delivery_promise_time, and actual_delivery_time. + carrier (str): + Optional. The name of the shipping carrier for the delivery. + This field is required if one of the following fields is + absent: earliest_delivery_promise_time, + latest_delivery_promise_time, and actual_delivery_time. + carrier_service (str): + Optional. The service type for fulfillment, such as GROUND, + FIRST_CLASS, etc. + shipped_time (google.type.datetime_pb2.DateTime): + Optional. The time when the shipment was + shipped. Include the year and timezone string, + if available. + earliest_delivery_promise_time (google.type.datetime_pb2.DateTime): + Optional. The earliest delivery promised time. Include the + year and timezone string, if available. This field is + required, if one of the following fields is absent: + tracking_id or carrier_name. + latest_delivery_promise_time (google.type.datetime_pb2.DateTime): + Optional. The latest delivery promised time. Include the + year and timezone string, if available. This field is + required, if one of the following fields is absent: + tracking_id or carrier_name. + actual_delivery_time (google.type.datetime_pb2.DateTime): + Optional. The time when the shipment was actually delivered. + Include the year and timezone string, if available. This + field is required, if one of the following fields is absent: + tracking_id or carrier_name. + shipping_status (google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal.ShippingInfo.ShippingState): + Required. The status of the shipment. + origin_postal_code (str): + Required. The origin postal code, as a + continuous string without spaces or dashes, for + example "95016". This field will be anonymized + in returned OrderTrackingSignal creation + response. + origin_region_code (str): + Required. The [CLDR territory code] + (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + for the shipping origin. + """ + class ShippingState(proto.Enum): + r"""The current status of the shipments. + + Values: + SHIPPING_STATE_UNSPECIFIED (0): + The shipping status is not known to business. + SHIPPED (1): + All items are shipped. + DELIVERED (2): + The shipment is already delivered. + """ + SHIPPING_STATE_UNSPECIFIED = 0 + SHIPPED = 1 + DELIVERED = 2 + + shipment_id: str = proto.Field( + proto.STRING, + number=1, + ) + tracking_id: str = proto.Field( + proto.STRING, + number=2, + ) + carrier: str = proto.Field( + proto.STRING, + number=3, + ) + carrier_service: str = proto.Field( + proto.STRING, + number=4, + ) + shipped_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=5, + message=datetime_pb2.DateTime, + ) + earliest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=6, + message=datetime_pb2.DateTime, + ) + latest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=7, + message=datetime_pb2.DateTime, + ) + actual_delivery_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=8, + message=datetime_pb2.DateTime, + ) + shipping_status: 'OrderTrackingSignal.ShippingInfo.ShippingState' = proto.Field( + proto.ENUM, + number=9, + enum='OrderTrackingSignal.ShippingInfo.ShippingState', + ) + origin_postal_code: str = proto.Field( + proto.STRING, + number=10, + ) + origin_region_code: str = proto.Field( + proto.STRING, + number=11, + ) + + class LineItemDetails(proto.Message): + r"""The line items of the order. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + line_item_id (str): + Required. The ID for this line item. + product_id (str): + Required. The Content API REST ID of the + product, in the form + channel:contentLanguage:targetCountry:offerId. + gtins (MutableSequence[str]): + Optional. The Global Trade Item Numbers. + mpn (str): + Optional. The manufacturer part number. + product_title (str): + Optional. Plain text title of this product. + + This field is a member of `oneof`_ ``_product_title``. + brand (str): + Optional. Brand of the product. + + This field is a member of `oneof`_ ``_brand``. + quantity (int): + Required. The quantity of the line item in + the order. + """ + + line_item_id: str = proto.Field( + proto.STRING, + number=1, + ) + product_id: str = proto.Field( + proto.STRING, + number=2, + ) + gtins: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=8, + ) + mpn: str = proto.Field( + proto.STRING, + number=4, + ) + product_title: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + quantity: int = proto.Field( + proto.INT64, + number=7, + ) + + class ShipmentLineItemMapping(proto.Message): + r"""Represents how many items are in the shipment for the given + shipment_id and line_item_id. + + Attributes: + shipment_id (str): + Required. The shipment ID. This field will be + hashed in returned OrderTrackingSignal creation + response. + line_item_id (str): + Required. The line item ID. + quantity (int): + Required. The line item quantity in the + shipment. + """ + + shipment_id: str = proto.Field( + proto.STRING, + number=1, + ) + line_item_id: str = proto.Field( + proto.STRING, + number=2, + ) + quantity: int = proto.Field( + proto.INT64, + number=3, + ) + + order_tracking_signal_id: int = proto.Field( + proto.INT64, + number=11, + ) + merchant_id: int = proto.Field( + proto.INT64, + number=12, + ) + order_created_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=1, + message=datetime_pb2.DateTime, + ) + order_id: str = proto.Field( + proto.STRING, + number=2, + ) + shipping_info: MutableSequence[ShippingInfo] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ShippingInfo, + ) + line_items: MutableSequence[LineItemDetails] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message=LineItemDetails, + ) + shipment_line_item_mapping: MutableSequence[ShipmentLineItemMapping] = proto.RepeatedField( + proto.MESSAGE, + number=5, + message=ShipmentLineItemMapping, + ) + customer_shipping_fee: types.Price = proto.Field( + proto.MESSAGE, + number=6, + optional=True, + message=types.Price, + ) + delivery_postal_code: str = proto.Field( + proto.STRING, + number=9, + ) + delivery_region_code: str = proto.Field( + proto.STRING, + number=10, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py new file mode 100644 index 000000000000..5a16b31cc051 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py @@ -0,0 +1,591 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import os +import pathlib +import re +import shutil + +from typing import Dict, List +import warnings + +import nox + +BLACK_VERSION = "black[jupyter]==23.7.0" +ISORT_VERSION = "isort==5.11.0" + +LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", + "3.12", + "3.13", +] + +DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = "google-shopping-merchant-ordertracking" + +UNIT_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "asyncmock", + "pytest", + "pytest-cov", + "pytest-asyncio", +] +UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_DEPENDENCIES: List[str] = [] +UNIT_TEST_EXTRAS: List[str] = [] +UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] +SYSTEM_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "pytest", + "google-cloud-testutils", +] +SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_EXTRAS: List[str] = [] +SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +nox.options.sessions = [ + "unit", + "system", + "cover", + "lint", + "lint_setup_py", + "blacken", + "docs", +] + +# Error if a python version is missing +nox.options.error_on_missing_interpreters = True + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + "mypy", + "types-requests", + "types-protobuf", + ) + session.install(".") + session.run( + "mypy", + "-p", + "google", + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install("google-cloud-testutils") + session.install(".") + + session.run( + "lower-bound-checker", + "update", + "--package-name", + PACKAGE_NAME, + "--constraints-file", + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install("google-cloud-testutils") + session.install(".") + + session.run( + "lower-bound-checker", + "check", + "--package-name", + PACKAGE_NAME, + "--constraints-file", + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *LINT_PATHS, + ) + + session.run("flake8", "google", "tests") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def format(session): + """ + Run isort to sort imports. Then run black + to format code to uniform standard. + """ + session.install(BLACK_VERSION, ISORT_VERSION) + # Use the --fss option to sort imports using strict alphabetical order. + # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections + session.run( + "isort", + "--fss", + *LINT_PATHS, + ) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("setuptools", "docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") + + +def install_unittest_dependencies(session, *constraints): + standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES + session.install(*standard_deps, *constraints) + + if UNIT_TEST_EXTERNAL_DEPENDENCIES: + warnings.warn( + "'unit_test_external_dependencies' is deprecated. Instead, please " + "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", + DeprecationWarning, + ) + session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_LOCAL_DEPENDENCIES: + session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_EXTRAS_BY_PYTHON: + extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif UNIT_TEST_EXTRAS: + extras = UNIT_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=ALL_PYTHON) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def unit(session, protobuf_implementation): + # Install all test dependencies, then install this package in-place. + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + install_unittest_dependencies(session, "-c", constraints_path) + + # TODO(https://github.com/googleapis/synthtool/issues/1976): + # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. + # The 'cpp' implementation requires Protobuf<4. + if protobuf_implementation == "cpp": + session.install("protobuf<4") + + # Run py.test against the unit tests. + session.run( + "py.test", + "--quiet", + f"--junitxml=unit_{session.python}_sponge_log.xml", + "--cov=google", + "--cov=tests/unit", + "--cov-append", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=0", + os.path.join("tests", "unit"), + *session.posargs, + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +def install_systemtest_dependencies(session, *constraints): + session.install("--pre", "grpcio") + + session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: + session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_LOCAL_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTRAS_BY_PYTHON: + extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif SYSTEM_TEST_EXTRAS: + extras = SYSTEM_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) +def system(session): + """Run the system test suite.""" + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + system_test_path = os.path.join("tests", "system.py") + system_test_folder_path = os.path.join("tests", "system") + + # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. + if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": + session.skip("RUN_SYSTEM_TESTS is set to false, skipping") + # Install pyopenssl for mTLS testing. + if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": + session.install("pyopenssl") + + system_test_exists = os.path.exists(system_test_path) + system_test_folder_exists = os.path.exists(system_test_folder_path) + # Sanity check: only run tests if found. + if not system_test_exists and not system_test_folder_exists: + session.skip("System tests were not found") + + install_systemtest_dependencies(session, "-c", constraints_path) + + # Run py.test against the system tests. + if system_test_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_path, + *session.posargs, + ) + if system_test_folder_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_folder_path, + *session.posargs, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python="3.10") +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "sphinx==4.5.0", + "alabaster", + "recommonmark", + ) + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python="3.10") +def docfx(session): + """Build the docfx yaml files for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "gcp-sphinx-docfx-yaml", + "alabaster", + "recommonmark", + ) + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-T", # show full traceback on exception + "-N", # no colors + "-D", + ( + "extensions=sphinx.ext.autodoc," + "sphinx.ext.autosummary," + "docfx_yaml.extension," + "sphinx.ext.intersphinx," + "sphinx.ext.coverage," + "sphinx.ext.napoleon," + "sphinx.ext.todo," + "sphinx.ext.viewcode," + "recommonmark" + ), + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def prerelease_deps(session, protobuf_implementation): + """ + Run all tests with pre-release versions of dependencies installed + rather than the standard non pre-release versions. + Pre-release versions can be installed using + `pip install --pre `. + """ + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # Note: If a dependency is added to the `prerel_deps` list, + # the `core_dependencies_from_source` list in the `core_deps_from_source` + # nox session should also be updated. + prerel_deps = [ + "googleapis-common-protos", + "google-api-core", + "google-auth", + "grpc-google-iam-v1", + "grpcio", + "grpcio-status", + "protobuf", + "proto-plus", + ] + + for dep in prerel_deps: + session.install("--pre", "--no-deps", "--ignore-installed", dep) + # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` + # to the dictionary below once this bug is fixed. + # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add + # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below + # once this bug is fixed. + package_namespaces = { + "google-api-core": "google.api_core", + "google-auth": "google.auth", + "grpcio": "grpc", + "protobuf": "google.protobuf", + "proto-plus": "proto", + } + + version_namespace = package_namespaces.get(dep) + + print(f"Installed {dep}") + if version_namespace: + session.run( + "python", + "-c", + f"import {version_namespace}; print({version_namespace}.__version__)", + ) + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb"], +) +def core_deps_from_source(session, protobuf_implementation): + """Run all tests with core dependencies installed from source + rather than pulling the dependencies from PyPI. + """ + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and + # `grpcio-status` should be added to the list below so that they are installed from source, + # rather than PyPI. + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be + # added to the list below so that it is installed from source, rather than PyPI + # Note: If a dependency is added to the `core_dependencies_from_source` list, + # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. + core_dependencies_from_source = [ + "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", + "google-api-core @ git+https://github.com/googleapis/python-api-core.git", + "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", + "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", + "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", + ] + + for dep in core_dependencies_from_source: + session.install(dep, "--no-deps", "--ignore-installed") + print(f"Installed {dep}") + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py new file mode 100644 index 000000000000..2aa26960629b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateOrderTrackingSignal +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-ordertracking + + +# [START merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_ordertracking_v1 + + +async def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1.OrderTrackingSignalsServiceAsyncClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = await client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py new file mode 100644 index 000000000000..3d04e8b03bf0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateOrderTrackingSignal +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-ordertracking + + +# [START merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_ordertracking_v1 + + +def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1.OrderTrackingSignalsServiceClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json new file mode 100644 index 000000000000..154ce01deb8b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json @@ -0,0 +1,184 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.ordertracking.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-ordertracking", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_ordertracking_v1.OrderTrackingSignalsServiceAsyncClient", + "shortName": "OrderTrackingSignalsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_ordertracking_v1.OrderTrackingSignalsServiceAsyncClient.create_order_tracking_signal", + "method": { + "fullName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService.CreateOrderTrackingSignal", + "service": { + "fullName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "shortName": "OrderTrackingSignalsService" + }, + "shortName": "CreateOrderTrackingSignal" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_ordertracking_v1.types.CreateOrderTrackingSignalRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "order_tracking_signal_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal", + "shortName": "create_order_tracking_signal" + }, + "description": "Sample for CreateOrderTrackingSignal", + "file": "merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_ordertracking_v1.OrderTrackingSignalsServiceClient", + "shortName": "OrderTrackingSignalsServiceClient" + }, + "fullName": "google.shopping.merchant_ordertracking_v1.OrderTrackingSignalsServiceClient.create_order_tracking_signal", + "method": { + "fullName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService.CreateOrderTrackingSignal", + "service": { + "fullName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", + "shortName": "OrderTrackingSignalsService" + }, + "shortName": "CreateOrderTrackingSignal" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_ordertracking_v1.types.CreateOrderTrackingSignalRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "order_tracking_signal_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_ordertracking_v1.types.OrderTrackingSignal", + "shortName": "create_order_tracking_signal" + }, + "description": "Sample for CreateOrderTrackingSignal", + "file": "merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py new file mode 100644 index 000000000000..10ea1b8455fe --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py @@ -0,0 +1,176 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class merchant_ordertrackingCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_order_tracking_signal': ('parent', 'order_tracking_signal', 'order_tracking_signal_id', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=merchant_ordertrackingCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the merchant_ordertracking client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py new file mode 100644 index 000000000000..44b1307169b0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import io +import os +import re + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-shopping-merchant-ordertracking' + + +description = "Google Shopping Merchant Ordertracking API client library" + +version = None + +with open(os.path.join(package_root, 'google/shopping/merchant_ordertracking/gapic_version.py')) as fp: + version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) + assert (len(version_candidates) == 1) + version = version_candidates[0] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + # Exclude incompatible versions of `google-auth` + # See https://github.com/googleapis/google-cloud-python/issues/12364 + "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", + "proto-plus >= 1.22.3, <2.0.0", + "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", + "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", + "google-shopping-type >= 0.1.6, <1.0.0", +] +extras = { +} +url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-shopping-merchant-ordertracking" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.find_namespace_packages() + if package.startswith("google") +] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + install_requires=dependencies, + extras_require=extras, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt new file mode 100644 index 000000000000..0112695e5bbb --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt @@ -0,0 +1,12 @@ +# We use the constraints file for the latest Python version +# (currently this file) to check that the latest +# major versions of dependencies are supported in setup.py. +# List all library dependencies and extras in this file. +# Require the latest major version be installed for each dependency. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", +# Then this file should have google-cloud-foo>=1 +google-api-core>=2 +google-auth>=2 +proto-plus>=1 +protobuf>=6 +google-shopping-type>=0 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt new file mode 100644 index 000000000000..2af887ec8ba0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt @@ -0,0 +1,11 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.1 +google-auth==2.14.1 +proto-plus==1.22.3 +protobuf==3.20.2 +google-shopping-type==0.1.6 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py new file mode 100644 index 000000000000..474f047a0593 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py @@ -0,0 +1,2243 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable, AsyncIterable +from google.protobuf import json_format +import json +import math +import pytest +from google.api_core import api_core_version +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +try: + from google.auth.aio import credentials as ga_credentials_async + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import OrderTrackingSignalsServiceClient +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import transports +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +import google.auth + + + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(None) is None + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + +def test__read_environment_variables(): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + OrderTrackingSignalsServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + OrderTrackingSignalsServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", "foo.com") + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, False) is None + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): + assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, True) is mock_default_cert_source + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source + +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + assert OrderTrackingSignalsServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + + with pytest.raises(MutualTLSChannelError) as excinfo: + OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") + assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert OrderTrackingSignalsServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain + assert OrderTrackingSignalsServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env + assert OrderTrackingSignalsServiceClient._get_universe_domain(None, None) == OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + + with pytest.raises(ValueError) as excinfo: + OrderTrackingSignalsServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + +@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False) +]) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = OrderTrackingSignalsServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + +@pytest.mark.parametrize("error_code", [401,403,404,500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = OrderTrackingSignalsServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + +@pytest.mark.parametrize("client_class,transport_name", [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), +]) +def test_order_tracking_signals_service_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://merchantapi.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +def test_order_tracking_signals_service_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), +]) +def test_order_tracking_signals_service_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://merchantapi.googleapis.com' + ) + + +def test_order_tracking_signals_service_client_get_transport_class(): + transport = OrderTrackingSignalsServiceClient.get_transport_class() + available_transports = [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceRestTransport, + ] + assert transport in available_transports + + transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc") + assert transport == transports.OrderTrackingSignalsServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "true"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "false"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "true"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "false"), +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_order_tracking_signals_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + +@pytest.mark.parametrize("client_class", [ + OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + else: + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) + assert client.universe_domain == (mock_universe if universe_exists else default_universe) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +def test_order_tracking_signals_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", None), +]) +def test_order_tracking_signals_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_order_tracking_signals_service_client_client_options_from_dict(): + with mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = OrderTrackingSignalsServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_order_tracking_signals_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + scopes=None, + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, +]) +def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + ) + response = client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +def test_create_order_tracking_signal_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = order_tracking_signals.CreateOrderTrackingSignalRequest( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_order_tracking_signal(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == order_tracking_signals.CreateOrderTrackingSignalRequest( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + +def test_create_order_tracking_signal_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + request = {} + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_order_tracking_signal in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_order_tracking_signal] = mock_rpc + + request = {} + await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio', request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + )) + response = await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async_from_dict(): + await test_create_order_tracking_signal_async(request_type=dict) + +def test_create_order_tracking_signal_field_headers(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = order_tracking_signals.OrderTrackingSignal() + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_field_headers_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_order_tracking_signal_flattened(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_order_tracking_signal( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].order_tracking_signal_id + mock_val = 'order_tracking_signal_id_value' + assert arg == mock_val + + +def test_create_order_tracking_signal_flattened_error(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_flattened_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_order_tracking_signal( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].order_tracking_signal_id + mock_val = 'order_tracking_signal_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_flattened_error_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + +def test_create_order_tracking_signal_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + + request = {} + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_order_tracking_signal_rest_required_fields(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + transport_class = transports.OrderTrackingSignalsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("order_tracking_signal_id", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_order_tracking_signal(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_order_tracking_signal_rest_unset_required_fields(): + transport = transports.OrderTrackingSignalsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_order_tracking_signal._get_unset_required_fields({}) + assert set(unset_fields) == (set(("orderTrackingSignalId", )) & set(("parent", "orderTrackingSignal", ))) + + +def test_create_order_tracking_signal_rest_flattened(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'accounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_order_tracking_signal(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals" % client.transport._host, args[1]) + + +def test_create_order_tracking_signal_rest_flattened_error(transport: str = 'rest'): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = OrderTrackingSignalsServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + transports.OrderTrackingSignalsServiceRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_kind_grpc(): + transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_order_tracking_signal_empty_call_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = order_tracking_signals.OrderTrackingSignal() + client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = OrderTrackingSignalsServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_order_tracking_signal_empty_call_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + )) + await client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = OrderTrackingSignalsServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_create_order_tracking_signal_rest_bad_request(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'parent': 'accounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_order_tracking_signal(request) + + +@pytest.mark.parametrize("request_type", [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, +]) +def test_create_order_tracking_signal_rest_call_success(request_type): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'accounts/sample1'} + request_init["order_tracking_signal"] = {'order_tracking_signal_id': 2519, 'merchant_id': 1150, 'order_created_time': {'year': 433, 'month': 550, 'day': 318, 'hours': 561, 'minutes': 773, 'seconds': 751, 'nanos': 543, 'utc_offset': {'seconds': 751, 'nanos': 543}, 'time_zone': {'id': 'id_value', 'version': 'version_value'}}, 'order_id': 'order_id_value', 'shipping_info': [{'shipment_id': 'shipment_id_value', 'tracking_id': 'tracking_id_value', 'carrier': 'carrier_value', 'carrier_service': 'carrier_service_value', 'shipped_time': {}, 'earliest_delivery_promise_time': {}, 'latest_delivery_promise_time': {}, 'actual_delivery_time': {}, 'shipping_status': 1, 'origin_postal_code': 'origin_postal_code_value', 'origin_region_code': 'origin_region_code_value'}], 'line_items': [{'line_item_id': 'line_item_id_value', 'product_id': 'product_id_value', 'gtins': ['gtins_value1', 'gtins_value2'], 'mpn': 'mpn_value', 'product_title': 'product_title_value', 'brand': 'brand_value', 'quantity': 895}], 'shipment_line_item_mapping': [{'shipment_id': 'shipment_id_value', 'line_item_id': 'line_item_id_value', 'quantity': 895}], 'customer_shipping_fee': {'amount_micros': 1408, 'currency_code': 'currency_code_value'}, 'delivery_postal_code': 'delivery_postal_code_value', 'delivery_region_code': 'delivery_region_code_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = order_tracking_signals.CreateOrderTrackingSignalRequest.meta.fields["order_tracking_signal"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["order_tracking_signal"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["order_tracking_signal"][field])): + del request_init["order_tracking_signal"][field][i][subfield] + else: + del request_init["order_tracking_signal"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_order_tracking_signal(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_order_tracking_signal_rest_interceptors(null_interceptor): + transport = transports.OrderTrackingSignalsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OrderTrackingSignalsServiceRestInterceptor(), + ) + client = OrderTrackingSignalsServiceClient(transport=transport) + + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal") as post, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "pre_create_order_tracking_signal") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(order_tracking_signals.CreateOrderTrackingSignalRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = order_tracking_signals.OrderTrackingSignal.to_json(order_tracking_signals.OrderTrackingSignal()) + req.return_value.content = return_value + + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = order_tracking_signals.OrderTrackingSignal() + post_with_metadata.return_value = order_tracking_signals.OrderTrackingSignal(), metadata + + client.create_order_tracking_signal(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + +def test_initialize_client_w_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_order_tracking_signal_empty_call_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.OrderTrackingSignalsServiceGrpcTransport, + ) + +def test_order_tracking_signals_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.OrderTrackingSignalsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_order_tracking_signals_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.OrderTrackingSignalsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_order_tracking_signal', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_order_tracking_signals_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OrderTrackingSignalsServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + quota_project_id="octopus", + ) + + +def test_order_tracking_signals_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OrderTrackingSignalsServiceTransport() + adc.assert_called_once() + + +def test_order_tracking_signals_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + OrderTrackingSignalsServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ], +) +def test_order_tracking_signals_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/content',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + transports.OrderTrackingSignalsServiceRestTransport, + ], +) +def test_order_tracking_signals_service_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.OrderTrackingSignalsServiceGrpcTransport, grpc_helpers), + (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_order_tracking_signals_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + scopes=["1", "2"], + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_order_tracking_signals_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.OrderTrackingSignalsServiceRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_order_tracking_signals_service_host_no_port(transport_name): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://merchantapi.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_order_tracking_signals_service_host_with_port(transport_name): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'merchantapi.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://merchantapi.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_order_tracking_signals_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = OrderTrackingSignalsServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = OrderTrackingSignalsServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_order_tracking_signal._session + session2 = client2.transport.create_order_tracking_signal._session + assert session1 != session2 +def test_order_tracking_signals_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_order_tracking_signals_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_account_path(): + account = "squid" + expected = "accounts/{account}".format(account=account, ) + actual = OrderTrackingSignalsServiceClient.account_path(account) + assert expected == actual + + +def test_parse_account_path(): + expected = { + "account": "clam", + } + path = OrderTrackingSignalsServiceClient.account_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_account_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = OrderTrackingSignalsServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = OrderTrackingSignalsServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format(folder=folder, ) + actual = OrderTrackingSignalsServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = OrderTrackingSignalsServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format(organization=organization, ) + actual = OrderTrackingSignalsServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = OrderTrackingSignalsServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format(project=project, ) + actual = OrderTrackingSignalsServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = OrderTrackingSignalsServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = OrderTrackingSignalsServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = OrderTrackingSignalsServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = OrderTrackingSignalsServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio" + ) + with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + with mock.patch.object(type(getattr(client.transport, "_session")), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc new file mode 100644 index 000000000000..c02611dc5807 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/shopping/merchant_ordertracking/__init__.py + google/shopping/merchant_ordertracking/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 new file mode 100644 index 000000000000..90316de21489 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 @@ -0,0 +1,34 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +[flake8] +# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): +# Resolve flake8 lint issues +ignore = E203, E231, E266, E501, W503 +exclude = + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): + # Ensure that generated code passes flake8 lint + **/gapic/** + **/services/** + **/types/** + # Exclude Protobuf gencode + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE new file mode 100644 index 000000000000..d64569567334 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in new file mode 100644 index 000000000000..dae249ec8976 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in @@ -0,0 +1,20 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +include README.rst LICENSE +recursive-include google *.py *.pyi *.json *.proto py.typed +recursive-include tests * +global-exclude *.py[co] +global-exclude __pycache__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst new file mode 100644 index 000000000000..c4e23cfbdc21 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst @@ -0,0 +1,143 @@ +Python Client for Google Shopping Merchant Ordertracking API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Shopping Merchant Ordertracking API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library + + +Logging +------- + +This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. +Note the following: + +#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. +#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. +#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. + + +Simple, environment-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google +logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged +messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging +event. + +A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. + +- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. +- Invalid logging scopes: :code:`foo`, :code:`123`, etc. + +**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. + + +Examples +^^^^^^^^ + +- Enabling the default handler for all Google-based loggers + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google + +- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: console + + export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 + + +Advanced, code-based configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can also configure a valid logging scope using Python's standard `logging` mechanism. + + +Examples +^^^^^^^^ + +- Configuring a handler for all Google-based loggers + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + +- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): + +.. code-block:: python + + import logging + + from google.cloud.translate_v3 import translate + + base_logger = logging.getLogger("google.cloud.library_v1") + base_logger.addHandler(logging.StreamHandler()) + base_logger.setLevel(logging.DEBUG) + + +Logging details +~~~~~~~~~~~~~~~ + +#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root + logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set + :code:`logging.getLogger("google").propagate = True` in your code. +#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for + one library, but decide you need to also set up environment-based logging configuration for another library. + + #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual + if the code -based configuration gets applied first. + +#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get + executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. + (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css new file mode 100644 index 000000000000..b0a295464b23 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css @@ -0,0 +1,20 @@ +div#python2-eol { + border-color: red; + border-width: medium; +} + +/* Ensure minimum width for 'Parameters' / 'Returns' column */ +dl.field-list > dt { + min-width: 100px +} + +/* Insert space between methods for readability */ +dl.method { + padding-top: 10px; + padding-bottom: 10px +} + +/* Insert empty space between classes */ +dl.class { + padding-bottom: 50px +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html new file mode 100644 index 000000000000..95e9c77fcfe1 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html @@ -0,0 +1,50 @@ + +{% extends "!layout.html" %} +{%- block content %} +{%- if theme_fixed_sidebar|lower == 'true' %} +
+ {{ sidebar() }} + {%- block document %} +
+ {%- if render_sidebar %} +
+ {%- endif %} + + {%- block relbar_top %} + {%- if theme_show_relbar_top|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + +
+
+ As of January 1, 2020 this library no longer supports Python 2 on the latest released version. + Library versions released prior to that date will continue to be available. For more information please + visit Python 2 support on Google Cloud. +
+ {% block body %} {% endblock %} +
+ + {%- block relbar_bottom %} + {%- if theme_show_relbar_bottom|tobool %} +
+   + {{- rellink_markup () }} +
+ {%- endif %} + {% endblock %} + + {%- if render_sidebar %} +
+ {%- endif %} +
+ {%- endblock %} +
+
+{%- else %} +{{ super() }} +{%- endif %} +{%- endblock %} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py new file mode 100644 index 000000000000..7a8d49f67478 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py @@ -0,0 +1,385 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# +# google-shopping-merchant-ordertracking documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +# For plugins that can not read conf.py. +# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 +sys.path.insert(0, os.path.abspath(".")) + +__version__ = "" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.5.0" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.doctest", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "recommonmark", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_options = {"members": True} +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-shopping-merchant-ordertracking" +copyright = u"2025, Google, LLC" +author = u"Google APIs" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [ + "_build", + "**/.nox/**/*", + "samples/AUTHORING_GUIDE.md", + "samples/CONTRIBUTING.md", + "samples/snippets/README.rst", +] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Shopping Client Libraries for google-shopping-merchant-ordertracking", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-shopping-merchant-ordertracking-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-shopping-merchant-ordertracking.tex", + u"google-shopping-merchant-ordertracking Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Documentation", + author, + "google-shopping-merchant-ordertracking", + "google-shopping-merchant-ordertracking Library", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "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.github.io/grpc/python/", None), + "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst new file mode 100644 index 000000000000..8ae1a3476cff --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst @@ -0,0 +1,10 @@ +.. include:: multiprocessing.rst + + +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_ordertracking_v1beta/services_ + merchant_ordertracking_v1beta/types_ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst new file mode 100644 index 000000000000..8ea4ebe68d44 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst @@ -0,0 +1,6 @@ +OrderTrackingSignalsService +--------------------------------------------- + +.. automodule:: google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service + :members: + :inherited-members: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst new file mode 100644 index 000000000000..9088106ddfc9 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst @@ -0,0 +1,6 @@ +Services for Google Shopping Merchant Ordertracking v1beta API +============================================================== +.. toctree:: + :maxdepth: 2 + + order_tracking_signals_service diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst new file mode 100644 index 000000000000..3eba5dd686ac --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Ordertracking v1beta API +=========================================================== + +.. automodule:: google.shopping.merchant_ordertracking_v1beta.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst new file mode 100644 index 000000000000..536d17b2ea65 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst @@ -0,0 +1,7 @@ +.. note:: + + Because this client uses :mod:`grpc` library, it is safe to + share instances across threads. In multiprocessing scenarios, the best + practice is to create client instances *after* the invocation of + :func:`os.fork` by :class:`multiprocessing.pool.Pool` or + :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py new file mode 100644 index 000000000000..2a36e786e848 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.shopping.merchant_ordertracking import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.client import OrderTrackingSignalsServiceClient +from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.async_client import OrderTrackingSignalsServiceAsyncClient + +from google.shopping.merchant_ordertracking_v1beta.types.order_tracking_signals import CreateOrderTrackingSignalRequest +from google.shopping.merchant_ordertracking_v1beta.types.order_tracking_signals import OrderTrackingSignal + +__all__ = ('OrderTrackingSignalsServiceClient', + 'OrderTrackingSignalsServiceAsyncClient', + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed new file mode 100644 index 000000000000..24d3a8286bc4 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py new file mode 100644 index 000000000000..b801bfe2f1fb --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py @@ -0,0 +1,32 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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.shopping.merchant_ordertracking_v1beta import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.order_tracking_signals_service import OrderTrackingSignalsServiceClient +from .services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient + +from .types.order_tracking_signals import CreateOrderTrackingSignalRequest +from .types.order_tracking_signals import OrderTrackingSignal + +__all__ = ( + 'OrderTrackingSignalsServiceAsyncClient', +'CreateOrderTrackingSignalRequest', +'OrderTrackingSignal', +'OrderTrackingSignalsServiceClient', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json new file mode 100644 index 000000000000..d3d8eed6c4b5 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json @@ -0,0 +1,43 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_ordertracking_v1beta", + "protoPackage": "google.shopping.merchant.ordertracking.v1beta", + "schema": "1.0", + "services": { + "OrderTrackingSignalsService": { + "clients": { + "grpc": { + "libraryClient": "OrderTrackingSignalsServiceClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + }, + "grpc-async": { + "libraryClient": "OrderTrackingSignalsServiceAsyncClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + }, + "rest": { + "libraryClient": "OrderTrackingSignalsServiceClient", + "rpcs": { + "CreateOrderTrackingSignal": { + "methods": [ + "create_order_tracking_signal" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed new file mode 100644 index 000000000000..24d3a8286bc4 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py new file mode 100644 index 000000000000..15b29929ccad --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 .client import OrderTrackingSignalsServiceClient +from .async_client import OrderTrackingSignalsServiceAsyncClient + +__all__ = ( + 'OrderTrackingSignalsServiceClient', + 'OrderTrackingSignalsServiceAsyncClient', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py new file mode 100644 index 000000000000..8afb2b1c5636 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py @@ -0,0 +1,396 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import logging as std_logging +from collections import OrderedDict +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .client import OrderTrackingSignalsServiceClient + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +class OrderTrackingSignalsServiceAsyncClient: + """Service to serve order tracking signals public API.""" + + _client: OrderTrackingSignalsServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + + account_path = staticmethod(OrderTrackingSignalsServiceClient.account_path) + parse_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_account_path) + common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_organization_path) + common_project_path = staticmethod(OrderTrackingSignalsServiceClient.common_project_path) + parse_common_project_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_project_path) + common_location_path = staticmethod(OrderTrackingSignalsServiceClient.common_location_path) + parse_common_location_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceAsyncClient: The constructed client. + """ + return OrderTrackingSignalsServiceClient.from_service_account_info.__func__(OrderTrackingSignalsServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceAsyncClient: The constructed client. + """ + return OrderTrackingSignalsServiceClient.from_service_account_file.__func__(OrderTrackingSignalsServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return OrderTrackingSignalsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> OrderTrackingSignalsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OrderTrackingSignalsServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = OrderTrackingSignalsServiceClient.get_transport_class + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the order tracking signals service async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OrderTrackingSignalsServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = OrderTrackingSignalsServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient`.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._client._transport, "_credentials") else { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "credentialsType": None, + } + ) + + async def create_order_tracking_signal(self, + request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Creates new order tracking signal. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_ordertracking_v1beta + + async def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = await client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest, dict]]): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + parent (:class:`str`): + Required. The account of the business + for which the order signal is created. + Format: accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + order_tracking_signal_id (:class:`str`): + Output only. The ID that uniquely + identifies this order tracking signal. + + This corresponds to the ``order_tracking_signal_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent, order_tracking_signal_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if order_tracking_signal_id is not None: + request.order_tracking_signal_id = order_tracking_signal_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_order_tracking_signal] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "OrderTrackingSignalsServiceAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ( + "OrderTrackingSignalsServiceAsyncClient", +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py new file mode 100644 index 000000000000..1fada41517e3 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py @@ -0,0 +1,756 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 collections import OrderedDict +from http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +import warnings + +from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import OrderTrackingSignalsServiceGrpcTransport +from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .transports.rest import OrderTrackingSignalsServiceRestTransport + + +class OrderTrackingSignalsServiceClientMeta(type): + """Metaclass for the OrderTrackingSignalsService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] + _transport_registry["grpc"] = OrderTrackingSignalsServiceGrpcTransport + _transport_registry["grpc_asyncio"] = OrderTrackingSignalsServiceGrpcAsyncIOTransport + _transport_registry["rest"] = OrderTrackingSignalsServiceRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[OrderTrackingSignalsServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class OrderTrackingSignalsServiceClient(metaclass=OrderTrackingSignalsServiceClientMeta): + """Service to serve order tracking signals public API.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + OrderTrackingSignalsServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> OrderTrackingSignalsServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OrderTrackingSignalsServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def account_path(account: str,) -> str: + """Returns a fully-qualified account string.""" + return "accounts/{account}".format(account=account, ) + + @staticmethod + def parse_account_path(path: str) -> Dict[str,str]: + """Parses a account path into its component segments.""" + m = re.match(r"^accounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + _default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + api_endpoint = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + return api_endpoint + + @staticmethod + def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, + error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the order tracking signals service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OrderTrackingSignalsServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + + universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + + self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OrderTrackingSignalsServiceClient._read_environment_variables() + self._client_cert_source = OrderTrackingSignalsServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) + self._universe_domain = OrderTrackingSignalsServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance(transport, OrderTrackingSignalsServiceTransport) + if transport_provided: + # transport is a OrderTrackingSignalsServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(OrderTrackingSignalsServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = (self._api_endpoint or + OrderTrackingSignalsServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint)) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + transport_init: Union[Type[OrderTrackingSignalsServiceTransport], Callable[..., OrderTrackingSignalsServiceTransport]] = ( + OrderTrackingSignalsServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., OrderTrackingSignalsServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient`.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), + } if hasattr(self._transport, "_credentials") else { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "credentialsType": None, + } + ) + + def create_order_tracking_signal(self, + request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Creates new order tracking signal. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_ordertracking_v1beta + + def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest, dict]): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + parent (str): + Required. The account of the business + for which the order signal is created. + Format: accounts/{account} + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + order_tracking_signal_id (str): + Output only. The ID that uniquely + identifies this order tracking signal. + + This corresponds to the ``order_tracking_signal_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent, order_tracking_signal_id] + has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if order_tracking_signal_id is not None: + request.order_tracking_signal_id = order_tracking_signal_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_order_tracking_signal] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "OrderTrackingSignalsServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ( + "OrderTrackingSignalsServiceClient", +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst new file mode 100644 index 000000000000..4c596b6640df --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`OrderTrackingSignalsServiceTransport` is the ABC for all transports. +- public child `OrderTrackingSignalsServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `OrderTrackingSignalsServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseOrderTrackingSignalsServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `OrderTrackingSignalsServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py new file mode 100644 index 000000000000..c1246dfdc064 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 collections import OrderedDict +from typing import Dict, Type + +from .base import OrderTrackingSignalsServiceTransport +from .grpc import OrderTrackingSignalsServiceGrpcTransport +from .grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport +from .rest import OrderTrackingSignalsServiceRestTransport +from .rest import OrderTrackingSignalsServiceRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] +_transport_registry['grpc'] = OrderTrackingSignalsServiceGrpcTransport +_transport_registry['grpc_asyncio'] = OrderTrackingSignalsServiceGrpcAsyncIOTransport +_transport_registry['rest'] = OrderTrackingSignalsServiceRestTransport + +__all__ = ( + 'OrderTrackingSignalsServiceTransport', + 'OrderTrackingSignalsServiceGrpcTransport', + 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', + 'OrderTrackingSignalsServiceRestTransport', + 'OrderTrackingSignalsServiceRestInterceptor', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py new file mode 100644 index 000000000000..a4268cd61d4e --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py @@ -0,0 +1,159 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class OrderTrackingSignalsServiceTransport(abc.ABC): + """Abstract transport class for OrderTrackingSignalsService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/content', + ) + + DEFAULT_HOST: str = 'merchantapi.googleapis.com' + + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_order_tracking_signal: gapic_v1.method.wrap_method( + self.create_order_tracking_signal, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Union[ + order_tracking_signals.OrderTrackingSignal, + Awaitable[order_tracking_signals.OrderTrackingSignal] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'OrderTrackingSignalsServiceTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py new file mode 100644 index 000000000000..a2c0f9e17da7 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py @@ -0,0 +1,346 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import json +import logging as std_logging +import pickle +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class OrderTrackingSignalsServiceGrpcTransport(OrderTrackingSignalsServiceTransport): + """gRPC backend transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal]: + r"""Return a callable for the create order tracking signal method over gRPC. + + Creates new order tracking signal. + + Returns: + Callable[[~.CreateOrderTrackingSignalRequest], + ~.OrderTrackingSignal]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_order_tracking_signal' not in self._stubs: + self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( + '/google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService/CreateOrderTrackingSignal', + request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, + response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, + ) + return self._stubs['create_order_tracking_signal'] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'OrderTrackingSignalsServiceGrpcTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..dddc753df6bb --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py @@ -0,0 +1,367 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import inspect +import json +import pickle +import logging as std_logging +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.api_core import exceptions as core_exceptions +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message + +import grpc # type: ignore +import proto # type: ignore +from grpc.experimental import aio # type: ignore + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import OrderTrackingSignalsServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class OrderTrackingSignalsServiceGrpcAsyncIOTransport(OrderTrackingSignalsServiceTransport): + """gRPC AsyncIO backend transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Awaitable[order_tracking_signals.OrderTrackingSignal]]: + r"""Return a callable for the create order tracking signal method over gRPC. + + Creates new order tracking signal. + + Returns: + Callable[[~.CreateOrderTrackingSignalRequest], + Awaitable[~.OrderTrackingSignal]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'create_order_tracking_signal' not in self._stubs: + self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( + '/google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService/CreateOrderTrackingSignal', + request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, + response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, + ) + return self._stubs['create_order_tracking_signal'] + + def _prep_wrapped_messages(self, client_info): + """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.create_order_tracking_signal: self._wrap_method( + self.create_order_tracking_signal, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ( + 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py new file mode 100644 index 000000000000..bcca227d36f3 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py @@ -0,0 +1,361 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import logging +import json # type: ignore + +from google.auth.transport.requests import AuthorizedSession # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import gapic_v1 +import google.protobuf + +from google.protobuf import json_format + +from requests import __version__ as requests_version +import dataclasses +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals + + +from .rest_base import _BaseOrderTrackingSignalsServiceRestTransport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class OrderTrackingSignalsServiceRestInterceptor: + """Interceptor for OrderTrackingSignalsService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the OrderTrackingSignalsServiceRestTransport. + + .. code-block:: python + class MyCustomOrderTrackingSignalsServiceInterceptor(OrderTrackingSignalsServiceRestInterceptor): + def pre_create_order_tracking_signal(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_order_tracking_signal(self, response): + logging.log(f"Received response: {response}") + return response + + transport = OrderTrackingSignalsServiceRestTransport(interceptor=MyCustomOrderTrackingSignalsServiceInterceptor()) + client = OrderTrackingSignalsServiceClient(transport=transport) + + + """ + def pre_create_order_tracking_signal(self, request: order_tracking_signals.CreateOrderTrackingSignalRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.CreateOrderTrackingSignalRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + """Pre-rpc interceptor for create_order_tracking_signal + + Override in a subclass to manipulate the request or metadata + before they are sent to the OrderTrackingSignalsService server. + """ + return request, metadata + + def post_create_order_tracking_signal(self, response: order_tracking_signals.OrderTrackingSignal) -> order_tracking_signals.OrderTrackingSignal: + """Post-rpc interceptor for create_order_tracking_signal + + DEPRECATED. Please use the `post_create_order_tracking_signal_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the OrderTrackingSignalsService server but before + it is returned to user code. This `post_create_order_tracking_signal` interceptor runs + before the `post_create_order_tracking_signal_with_metadata` interceptor. + """ + return response + + def post_create_order_tracking_signal_with_metadata(self, response: order_tracking_signals.OrderTrackingSignal, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.OrderTrackingSignal, Sequence[Tuple[str, Union[str, bytes]]]]: + """Post-rpc interceptor for create_order_tracking_signal + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the OrderTrackingSignalsService server but before it is returned to user code. + + We recommend only using this `post_create_order_tracking_signal_with_metadata` + interceptor in new development instead of the `post_create_order_tracking_signal` interceptor. + When both interceptors are used, this `post_create_order_tracking_signal_with_metadata` interceptor runs after the + `post_create_order_tracking_signal` interceptor. The (possibly modified) response returned by + `post_create_order_tracking_signal` will be passed to + `post_create_order_tracking_signal_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class OrderTrackingSignalsServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: OrderTrackingSignalsServiceRestInterceptor + + +class OrderTrackingSignalsServiceRestTransport(_BaseOrderTrackingSignalsServiceRestTransport): + """REST backend synchronous transport for OrderTrackingSignalsService. + + Service to serve order tracking signals public API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[OrderTrackingSignalsServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or OrderTrackingSignalsServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateOrderTrackingSignal(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal, OrderTrackingSignalsServiceRestStub): + def __hash__(self): + return hash("OrderTrackingSignalsServiceRestTransport.CreateOrderTrackingSignal") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None): + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__(self, + request: order_tracking_signals.CreateOrderTrackingSignalRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), + ) -> order_tracking_signals.OrderTrackingSignal: + r"""Call the create order tracking + signal method over HTTP. + + Args: + request (~.order_tracking_signals.CreateOrderTrackingSignalRequest): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.order_tracking_signals.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. + + """ + + http_options = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_http_options() + + request, metadata = self._interceptor.pre_create_order_tracking_signal(request, metadata) + transcoded_request = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_transcoded_request(http_options, request) + + body = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_request_body_json(transcoded_request) + + # Jsonify the query params + query_params = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_query_params_json(transcoded_request) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) + method = transcoded_request['method'] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient.CreateOrderTrackingSignal", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": "CreateOrderTrackingSignal", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = OrderTrackingSignalsServiceRestTransport._CreateOrderTrackingSignal._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, body) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = order_tracking_signals.OrderTrackingSignal() + pb_resp = order_tracking_signals.OrderTrackingSignal.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_order_tracking_signal(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_create_order_tracking_signal_with_metadata(resp, response_metadata) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + try: + response_payload = order_tracking_signals.OrderTrackingSignal.to_json(response) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient.create_order_tracking_signal", + extra = { + "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "rpcName": "CreateOrderTrackingSignal", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def create_order_tracking_signal(self) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._CreateOrderTrackingSignal(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'OrderTrackingSignalsServiceRestTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py new file mode 100644 index 000000000000..b1321ddf046b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py @@ -0,0 +1,138 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import json # type: ignore +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + + +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals + + +class _BaseOrderTrackingSignalsServiceRestTransport(OrderTrackingSignalsServiceTransport): + """Base REST backend transport for OrderTrackingSignalsService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__(self, *, + host: str = 'merchantapi.googleapis.com', + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[Any]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + + class _BaseCreateOrderTrackingSignal: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/ordertracking/v1beta/{parent=accounts/*}/ordertrackingsignals', + 'body': 'order_tracking_signal', + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + return body + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__=( + '_BaseOrderTrackingSignalsServiceRestTransport', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py new file mode 100644 index 000000000000..d1e7569d2768 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py @@ -0,0 +1,24 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 .order_tracking_signals import ( + CreateOrderTrackingSignalRequest, + OrderTrackingSignal, +) + +__all__ = ( + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py new file mode 100644 index 000000000000..678343f40cd7 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py @@ -0,0 +1,375 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.shopping.merchant.ordertracking.v1beta', + manifest={ + 'CreateOrderTrackingSignalRequest', + 'OrderTrackingSignal', + }, +) + + +class CreateOrderTrackingSignalRequest(proto.Message): + r"""Signals only can be created but not updated. + Businesses need to call this API only when the order is + completely shipped. Creates new order signal. + + Attributes: + parent (str): + Required. The account of the business for + which the order signal is created. Format: + accounts/{account} + order_tracking_signal_id (str): + Output only. The ID that uniquely identifies + this order tracking signal. + order_tracking_signal (google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal): + Required. The order signal to be created. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + order_tracking_signal_id: str = proto.Field( + proto.STRING, + number=2, + ) + order_tracking_signal: 'OrderTrackingSignal' = proto.Field( + proto.MESSAGE, + number=3, + message='OrderTrackingSignal', + ) + + +class OrderTrackingSignal(proto.Message): + r"""Represents a business trade from which signals are extracted, + such as shipping. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + order_tracking_signal_id (int): + Output only. The ID that uniquely identifies + this order tracking signal. + merchant_id (int): + Optional. The Google Merchant Center ID of this order + tracking signal. This value is optional. If left unset, the + caller's Merchant Center ID is used. You must request access + in order to provide data on behalf of another business. For + more information, see `Submitting Order Tracking + Signals `__. + order_created_time (google.type.datetime_pb2.DateTime): + Required. The time when the order was created + on the businesses side. Include the year and + timezone string, if available. + order_id (str): + Required. The ID of the order on the + businesses side. This field will be hashed in + returned OrderTrackingSignal creation response. + shipping_info (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShippingInfo]): + Required. The shipping information for the + order. + line_items (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.LineItemDetails]): + Required. Information about line items in the + order. + shipment_line_item_mapping (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShipmentLineItemMapping]): + Optional. The mapping of the line items to + the shipment information. + customer_shipping_fee (google.shopping.type.types.Price): + Optional. The shipping fee of the order; + this value should be set to zero in the case of + free shipping. + + This field is a member of `oneof`_ ``_customer_shipping_fee``. + delivery_postal_code (str): + Optional. The delivery postal code, as a + continuous string without spaces or dashes, for + example "95016". This field will be anonymized + in returned OrderTrackingSignal creation + response. + delivery_region_code (str): + Optional. The [CLDR territory code] + (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + for the shipping destination. + """ + + class ShippingInfo(proto.Message): + r"""The shipping information for the order. + + Attributes: + shipment_id (str): + Required. The shipment ID. This field will be + hashed in returned OrderTrackingSignal creation + response. + tracking_id (str): + Optional. The tracking ID of the shipment. This field is + required if one of the following fields is absent: + earliest_delivery_promise_time, + latest_delivery_promise_time, and actual_delivery_time. + carrier (str): + Optional. The name of the shipping carrier for the delivery. + This field is required if one of the following fields is + absent: earliest_delivery_promise_time, + latest_delivery_promise_time, and actual_delivery_time. + carrier_service (str): + Optional. The service type for fulfillment, such as GROUND, + FIRST_CLASS, etc. + shipped_time (google.type.datetime_pb2.DateTime): + Optional. The time when the shipment was + shipped. Include the year and timezone string, + if available. + earliest_delivery_promise_time (google.type.datetime_pb2.DateTime): + Optional. The earliest delivery promised time. Include the + year and timezone string, if available. This field is + required, if one of the following fields is absent: + tracking_id or carrier_name. + latest_delivery_promise_time (google.type.datetime_pb2.DateTime): + Optional. The latest delivery promised time. Include the + year and timezone string, if available. This field is + required, if one of the following fields is absent: + tracking_id or carrier_name. + actual_delivery_time (google.type.datetime_pb2.DateTime): + Optional. The time when the shipment was actually delivered. + Include the year and timezone string, if available. This + field is required, if one of the following fields is absent: + tracking_id or carrier_name. + shipping_status (google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShippingInfo.ShippingState): + Required. The status of the shipment. + origin_postal_code (str): + Required. The origin postal code, as a + continuous string without spaces or dashes, for + example "95016". This field will be anonymized + in returned OrderTrackingSignal creation + response. + origin_region_code (str): + Required. The [CLDR territory code] + (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + for the shipping origin. + """ + class ShippingState(proto.Enum): + r"""The current status of the shipments. + + Values: + SHIPPING_STATE_UNSPECIFIED (0): + The shipping status is not known to business. + SHIPPED (1): + All items are shipped. + DELIVERED (2): + The shipment is already delivered. + """ + SHIPPING_STATE_UNSPECIFIED = 0 + SHIPPED = 1 + DELIVERED = 2 + + shipment_id: str = proto.Field( + proto.STRING, + number=1, + ) + tracking_id: str = proto.Field( + proto.STRING, + number=2, + ) + carrier: str = proto.Field( + proto.STRING, + number=3, + ) + carrier_service: str = proto.Field( + proto.STRING, + number=4, + ) + shipped_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=5, + message=datetime_pb2.DateTime, + ) + earliest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=6, + message=datetime_pb2.DateTime, + ) + latest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=7, + message=datetime_pb2.DateTime, + ) + actual_delivery_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=8, + message=datetime_pb2.DateTime, + ) + shipping_status: 'OrderTrackingSignal.ShippingInfo.ShippingState' = proto.Field( + proto.ENUM, + number=9, + enum='OrderTrackingSignal.ShippingInfo.ShippingState', + ) + origin_postal_code: str = proto.Field( + proto.STRING, + number=10, + ) + origin_region_code: str = proto.Field( + proto.STRING, + number=11, + ) + + class LineItemDetails(proto.Message): + r"""The line items of the order. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + line_item_id (str): + Required. The ID for this line item. + product_id (str): + Required. The Content API REST ID of the + product, in the form + channel:contentLanguage:targetCountry:offerId. + gtin (str): + Optional. The Global Trade Item Number. + mpn (str): + Optional. The manufacturer part number. + product_title (str): + Optional. Plain text title of this product. + + This field is a member of `oneof`_ ``_product_title``. + brand (str): + Optional. Brand of the product. + + This field is a member of `oneof`_ ``_brand``. + quantity (int): + Required. The quantity of the line item in + the order. + """ + + line_item_id: str = proto.Field( + proto.STRING, + number=1, + ) + product_id: str = proto.Field( + proto.STRING, + number=2, + ) + gtin: str = proto.Field( + proto.STRING, + number=3, + ) + mpn: str = proto.Field( + proto.STRING, + number=4, + ) + product_title: str = proto.Field( + proto.STRING, + number=5, + optional=True, + ) + brand: str = proto.Field( + proto.STRING, + number=6, + optional=True, + ) + quantity: int = proto.Field( + proto.INT64, + number=7, + ) + + class ShipmentLineItemMapping(proto.Message): + r"""Represents how many items are in the shipment for the given + shipment_id and line_item_id. + + Attributes: + shipment_id (str): + Required. The shipment ID. This field will be + hashed in returned OrderTrackingSignal creation + response. + line_item_id (str): + Required. The line item ID. + quantity (int): + Required. The line item quantity in the + shipment. + """ + + shipment_id: str = proto.Field( + proto.STRING, + number=1, + ) + line_item_id: str = proto.Field( + proto.STRING, + number=2, + ) + quantity: int = proto.Field( + proto.INT64, + number=3, + ) + + order_tracking_signal_id: int = proto.Field( + proto.INT64, + number=11, + ) + merchant_id: int = proto.Field( + proto.INT64, + number=12, + ) + order_created_time: datetime_pb2.DateTime = proto.Field( + proto.MESSAGE, + number=1, + message=datetime_pb2.DateTime, + ) + order_id: str = proto.Field( + proto.STRING, + number=2, + ) + shipping_info: MutableSequence[ShippingInfo] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ShippingInfo, + ) + line_items: MutableSequence[LineItemDetails] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message=LineItemDetails, + ) + shipment_line_item_mapping: MutableSequence[ShipmentLineItemMapping] = proto.RepeatedField( + proto.MESSAGE, + number=5, + message=ShipmentLineItemMapping, + ) + customer_shipping_fee: types.Price = proto.Field( + proto.MESSAGE, + number=6, + optional=True, + message=types.Price, + ) + delivery_postal_code: str = proto.Field( + proto.STRING, + number=9, + ) + delivery_region_code: str = proto.Field( + proto.STRING, + number=10, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py new file mode 100644 index 000000000000..5a16b31cc051 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py @@ -0,0 +1,591 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import os +import pathlib +import re +import shutil + +from typing import Dict, List +import warnings + +import nox + +BLACK_VERSION = "black[jupyter]==23.7.0" +ISORT_VERSION = "isort==5.11.0" + +LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", + "3.12", + "3.13", +] + +DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = "google-shopping-merchant-ordertracking" + +UNIT_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "asyncmock", + "pytest", + "pytest-cov", + "pytest-asyncio", +] +UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] +UNIT_TEST_DEPENDENCIES: List[str] = [] +UNIT_TEST_EXTRAS: List[str] = [] +UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] +SYSTEM_TEST_STANDARD_DEPENDENCIES = [ + "mock", + "pytest", + "google-cloud-testutils", +] +SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_DEPENDENCIES: List[str] = [] +SYSTEM_TEST_EXTRAS: List[str] = [] +SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} + +nox.options.sessions = [ + "unit", + "system", + "cover", + "lint", + "lint_setup_py", + "blacken", + "docs", +] + +# Error if a python version is missing +nox.options.error_on_missing_interpreters = True + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + "mypy", + "types-requests", + "types-protobuf", + ) + session.install(".") + session.run( + "mypy", + "-p", + "google", + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install("google-cloud-testutils") + session.install(".") + + session.run( + "lower-bound-checker", + "update", + "--package-name", + PACKAGE_NAME, + "--constraints-file", + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install("google-cloud-testutils") + session.install(".") + + session.run( + "lower-bound-checker", + "check", + "--package-name", + PACKAGE_NAME, + "--constraints-file", + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *LINT_PATHS, + ) + + session.run("flake8", "google", "tests") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def format(session): + """ + Run isort to sort imports. Then run black + to format code to uniform standard. + """ + session.install(BLACK_VERSION, ISORT_VERSION) + # Use the --fss option to sort imports using strict alphabetical order. + # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections + session.run( + "isort", + "--fss", + *LINT_PATHS, + ) + session.run( + "black", + *LINT_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("setuptools", "docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") + + +def install_unittest_dependencies(session, *constraints): + standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES + session.install(*standard_deps, *constraints) + + if UNIT_TEST_EXTERNAL_DEPENDENCIES: + warnings.warn( + "'unit_test_external_dependencies' is deprecated. Instead, please " + "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", + DeprecationWarning, + ) + session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_LOCAL_DEPENDENCIES: + session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) + + if UNIT_TEST_EXTRAS_BY_PYTHON: + extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif UNIT_TEST_EXTRAS: + extras = UNIT_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=ALL_PYTHON) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def unit(session, protobuf_implementation): + # Install all test dependencies, then install this package in-place. + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + install_unittest_dependencies(session, "-c", constraints_path) + + # TODO(https://github.com/googleapis/synthtool/issues/1976): + # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. + # The 'cpp' implementation requires Protobuf<4. + if protobuf_implementation == "cpp": + session.install("protobuf<4") + + # Run py.test against the unit tests. + session.run( + "py.test", + "--quiet", + f"--junitxml=unit_{session.python}_sponge_log.xml", + "--cov=google", + "--cov=tests/unit", + "--cov-append", + "--cov-config=.coveragerc", + "--cov-report=", + "--cov-fail-under=0", + os.path.join("tests", "unit"), + *session.posargs, + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +def install_systemtest_dependencies(session, *constraints): + session.install("--pre", "grpcio") + + session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: + session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_LOCAL_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_DEPENDENCIES: + session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) + + if SYSTEM_TEST_EXTRAS_BY_PYTHON: + extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) + elif SYSTEM_TEST_EXTRAS: + extras = SYSTEM_TEST_EXTRAS + else: + extras = [] + + if extras: + session.install("-e", f".[{','.join(extras)}]", *constraints) + else: + session.install("-e", ".", *constraints) + + +@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) +def system(session): + """Run the system test suite.""" + constraints_path = str( + CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" + ) + system_test_path = os.path.join("tests", "system.py") + system_test_folder_path = os.path.join("tests", "system") + + # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. + if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": + session.skip("RUN_SYSTEM_TESTS is set to false, skipping") + # Install pyopenssl for mTLS testing. + if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": + session.install("pyopenssl") + + system_test_exists = os.path.exists(system_test_path) + system_test_folder_exists = os.path.exists(system_test_folder_path) + # Sanity check: only run tests if found. + if not system_test_exists and not system_test_folder_exists: + session.skip("System tests were not found") + + install_systemtest_dependencies(session, "-c", constraints_path) + + # Run py.test against the system tests. + if system_test_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_path, + *session.posargs, + ) + if system_test_folder_exists: + session.run( + "py.test", + "--quiet", + f"--junitxml=system_{session.python}_sponge_log.xml", + system_test_folder_path, + *session.posargs, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python="3.10") +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "sphinx==4.5.0", + "alabaster", + "recommonmark", + ) + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python="3.10") +def docfx(session): + """Build the docfx yaml files for this library.""" + + session.install("-e", ".") + session.install( + # We need to pin to specific versions of the `sphinxcontrib-*` packages + # which still support sphinx 4.x. + # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 + # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. + "sphinxcontrib-applehelp==1.0.4", + "sphinxcontrib-devhelp==1.0.2", + "sphinxcontrib-htmlhelp==2.0.1", + "sphinxcontrib-qthelp==1.0.3", + "sphinxcontrib-serializinghtml==1.1.5", + "gcp-sphinx-docfx-yaml", + "alabaster", + "recommonmark", + ) + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-T", # show full traceback on exception + "-N", # no colors + "-D", + ( + "extensions=sphinx.ext.autodoc," + "sphinx.ext.autosummary," + "docfx_yaml.extension," + "sphinx.ext.intersphinx," + "sphinx.ext.coverage," + "sphinx.ext.napoleon," + "sphinx.ext.todo," + "sphinx.ext.viewcode," + "recommonmark" + ), + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def prerelease_deps(session, protobuf_implementation): + """ + Run all tests with pre-release versions of dependencies installed + rather than the standard non pre-release versions. + Pre-release versions can be installed using + `pip install --pre `. + """ + + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): + session.skip("cpp implementation is not supported in python 3.11+") + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # Note: If a dependency is added to the `prerel_deps` list, + # the `core_dependencies_from_source` list in the `core_deps_from_source` + # nox session should also be updated. + prerel_deps = [ + "googleapis-common-protos", + "google-api-core", + "google-auth", + "grpc-google-iam-v1", + "grpcio", + "grpcio-status", + "protobuf", + "proto-plus", + ] + + for dep in prerel_deps: + session.install("--pre", "--no-deps", "--ignore-installed", dep) + # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` + # to the dictionary below once this bug is fixed. + # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add + # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below + # once this bug is fixed. + package_namespaces = { + "google-api-core": "google.api_core", + "google-auth": "google.auth", + "grpcio": "grpc", + "protobuf": "google.protobuf", + "proto-plus": "proto", + } + + version_namespace = package_namespaces.get(dep) + + print(f"Installed {dep}") + if version_namespace: + session.run( + "python", + "-c", + f"import {version_namespace}; print({version_namespace}.__version__)", + ) + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb"], +) +def core_deps_from_source(session, protobuf_implementation): + """Run all tests with core dependencies installed from source + rather than pulling the dependencies from PyPI. + """ + + # Install all dependencies + session.install("-e", ".") + + # Install dependencies for the unit test environment + unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES + session.install(*unit_deps_all) + + # Install dependencies for the system test environment + system_deps_all = ( + SYSTEM_TEST_STANDARD_DEPENDENCIES + + SYSTEM_TEST_EXTERNAL_DEPENDENCIES + + SYSTEM_TEST_EXTRAS + ) + session.install(*system_deps_all) + + # Because we test minimum dependency versions on the minimum Python + # version, the first version we test with in the unit tests sessions has a + # constraints file containing all dependencies and extras. + with open( + CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + # Install dependencies specified in `testing/constraints-X.txt`. + session.install(*constraints_deps) + + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and + # `grpcio-status` should be added to the list below so that they are installed from source, + # rather than PyPI. + # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be + # added to the list below so that it is installed from source, rather than PyPI + # Note: If a dependency is added to the `core_dependencies_from_source` list, + # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. + core_dependencies_from_source = [ + "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", + "google-api-core @ git+https://github.com/googleapis/python-api-core.git", + "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", + "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", + "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", + ] + + for dep in core_dependencies_from_source: + session.install(dep, "--no-deps", "--ignore-installed") + print(f"Installed {dep}") + + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py new file mode 100644 index 000000000000..b9bc40ca3b27 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateOrderTrackingSignal +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-ordertracking + + +# [START merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_ordertracking_v1beta + + +async def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = await client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py new file mode 100644 index 000000000000..a4cab8b8aa25 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for CreateOrderTrackingSignal +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-ordertracking + + +# [START merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_ordertracking_v1beta + + +def sample_create_order_tracking_signal(): + # Create a client + client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient() + + # Initialize request argument(s) + order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() + order_tracking_signal.order_id = "order_id_value" + order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" + order_tracking_signal.shipping_info.shipping_status = "DELIVERED" + order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" + order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" + order_tracking_signal.line_items.line_item_id = "line_item_id_value" + order_tracking_signal.line_items.product_id = "product_id_value" + order_tracking_signal.line_items.quantity = 895 + + request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( + parent="parent_value", + order_tracking_signal=order_tracking_signal, + ) + + # Make the request + response = client.create_order_tracking_signal(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json new file mode 100644 index 000000000000..a8d7d063cb20 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json @@ -0,0 +1,184 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.ordertracking.v1beta", + "version": "v1beta" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-ordertracking", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient", + "shortName": "OrderTrackingSignalsServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient.create_order_tracking_signal", + "method": { + "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService.CreateOrderTrackingSignal", + "service": { + "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "shortName": "OrderTrackingSignalsService" + }, + "shortName": "CreateOrderTrackingSignal" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "order_tracking_signal_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal", + "shortName": "create_order_tracking_signal" + }, + "description": "Sample for CreateOrderTrackingSignal", + "file": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient", + "shortName": "OrderTrackingSignalsServiceClient" + }, + "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient.create_order_tracking_signal", + "method": { + "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService.CreateOrderTrackingSignal", + "service": { + "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", + "shortName": "OrderTrackingSignalsService" + }, + "shortName": "CreateOrderTrackingSignal" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "order_tracking_signal_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal", + "shortName": "create_order_tracking_signal" + }, + "description": "Sample for CreateOrderTrackingSignal", + "file": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync", + "segments": [ + { + "end": 62, + "start": 27, + "type": "FULL" + }, + { + "end": 62, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 56, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 59, + "start": 57, + "type": "REQUEST_EXECUTION" + }, + { + "end": 63, + "start": 60, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py new file mode 100644 index 000000000000..10ea1b8455fe --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py @@ -0,0 +1,176 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class merchant_ordertrackingCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_order_tracking_signal': ('parent', 'order_tracking_signal', 'order_tracking_signal_id', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=merchant_ordertrackingCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the merchant_ordertracking client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py new file mode 100644 index 000000000000..44b1307169b0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import io +import os +import re + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-shopping-merchant-ordertracking' + + +description = "Google Shopping Merchant Ordertracking API client library" + +version = None + +with open(os.path.join(package_root, 'google/shopping/merchant_ordertracking/gapic_version.py')) as fp: + version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) + assert (len(version_candidates) == 1) + version = version_candidates[0] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + # Exclude incompatible versions of `google-auth` + # See https://github.com/googleapis/google-cloud-python/issues/12364 + "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", + "proto-plus >= 1.22.3, <2.0.0", + "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", + "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", + "google-shopping-type >= 0.1.6, <1.0.0", +] +extras = { +} +url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-shopping-merchant-ordertracking" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.find_namespace_packages() + if package.startswith("google") +] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + install_requires=dependencies, + extras_require=extras, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt new file mode 100644 index 000000000000..0112695e5bbb --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt @@ -0,0 +1,12 @@ +# We use the constraints file for the latest Python version +# (currently this file) to check that the latest +# major versions of dependencies are supported in setup.py. +# List all library dependencies and extras in this file. +# Require the latest major version be installed for each dependency. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", +# Then this file should have google-cloud-foo>=1 +google-api-core>=2 +google-auth>=2 +proto-plus>=1 +protobuf>=6 +google-shopping-type>=0 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt new file mode 100644 index 000000000000..2af887ec8ba0 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt @@ -0,0 +1,11 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.1 +google-auth==2.14.1 +proto-plus==1.22.3 +protobuf==3.20.2 +google-shopping-type==0.1.6 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt new file mode 100644 index 000000000000..4cae520d02b2 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py new file mode 100644 index 000000000000..191773d5572d --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py new file mode 100644 index 000000000000..2b93e3431d76 --- /dev/null +++ b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py @@ -0,0 +1,2243 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable, AsyncIterable +from google.protobuf import json_format +import json +import math +import pytest +from google.api_core import api_core_version +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +try: + from google.auth.aio import credentials as ga_credentials_async + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account +from google.protobuf import duration_pb2 # type: ignore +from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient +from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import OrderTrackingSignalsServiceClient +from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import transports +from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals +from google.shopping.type.types import types +from google.type import datetime_pb2 # type: ignore +import google.auth + + + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(None) is None + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + +def test__read_environment_variables(): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + OrderTrackingSignalsServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + OrderTrackingSignalsServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", "foo.com") + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, False) is None + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): + assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, True) is mock_default_cert_source + assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source + +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + assert OrderTrackingSignalsServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint + assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + + with pytest.raises(MutualTLSChannelError) as excinfo: + OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") + assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert OrderTrackingSignalsServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain + assert OrderTrackingSignalsServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env + assert OrderTrackingSignalsServiceClient._get_universe_domain(None, None) == OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + + with pytest.raises(ValueError) as excinfo: + OrderTrackingSignalsServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + +@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False) +]) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = OrderTrackingSignalsServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + +@pytest.mark.parametrize("error_code", [401,403,404,500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = OrderTrackingSignalsServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + +@pytest.mark.parametrize("client_class,transport_name", [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), +]) +def test_order_tracking_signals_service_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://merchantapi.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +def test_order_tracking_signals_service_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), +]) +def test_order_tracking_signals_service_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://merchantapi.googleapis.com' + ) + + +def test_order_tracking_signals_service_client_get_transport_class(): + transport = OrderTrackingSignalsServiceClient.get_transport_class() + available_transports = [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceRestTransport, + ] + assert transport in available_transports + + transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc") + assert transport == transports.OrderTrackingSignalsServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "true"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "false"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "true"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "false"), +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_order_tracking_signals_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + +@pytest.mark.parametrize("client_class", [ + OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient +]) +@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) +@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +def test_order_tracking_signals_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + else: + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) + assert client.universe_domain == (mock_universe if universe_exists else default_universe) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), +]) +def test_order_tracking_signals_service_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", None), +]) +def test_order_tracking_signals_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_order_tracking_signals_service_client_client_options_from_dict(): + with mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = OrderTrackingSignalsServiceClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_order_tracking_signals_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + scopes=None, + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, +]) +def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + ) + response = client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +def test_create_order_tracking_signal_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = order_tracking_signals.CreateOrderTrackingSignalRequest( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_order_tracking_signal(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == order_tracking_signals.CreateOrderTrackingSignalRequest( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + +def test_create_order_tracking_signal_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + request = {} + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_order_tracking_signal in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[client._client._transport.create_order_tracking_signal] = mock_rpc + + request = {} + await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio', request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + )) + response = await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_async_from_dict(): + await test_create_order_tracking_signal_async(request_type=dict) + +def test_create_order_tracking_signal_field_headers(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = order_tracking_signals.OrderTrackingSignal() + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_field_headers_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + await client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_order_tracking_signal_flattened(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_order_tracking_signal( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].order_tracking_signal_id + mock_val = 'order_tracking_signal_id_value' + assert arg == mock_val + + +def test_create_order_tracking_signal_flattened_error(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_flattened_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = order_tracking_signals.OrderTrackingSignal() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_order_tracking_signal( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].order_tracking_signal_id + mock_val = 'order_tracking_signal_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_order_tracking_signal_flattened_error_async(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + +def test_create_order_tracking_signal_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + + request = {} + client.create_order_tracking_signal(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_order_tracking_signal(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_order_tracking_signal_rest_required_fields(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + transport_class = transports.OrderTrackingSignalsServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("order_tracking_signal_id", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.create_order_tracking_signal(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_order_tracking_signal_rest_unset_required_fields(): + transport = transports.OrderTrackingSignalsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_order_tracking_signal._get_unset_required_fields({}) + assert set(unset_fields) == (set(("orderTrackingSignalId", )) & set(("parent", "orderTrackingSignal", ))) + + +def test_create_order_tracking_signal_rest_flattened(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'accounts/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.create_order_tracking_signal(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/ordertracking/v1beta/{parent=accounts/*}/ordertrackingsignals" % client.transport._host, args[1]) + + +def test_create_order_tracking_signal_rest_flattened_error(transport: str = 'rest'): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.create_order_tracking_signal( + order_tracking_signals.CreateOrderTrackingSignalRequest(), + parent='parent_value', + order_tracking_signal_id='order_tracking_signal_id_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OrderTrackingSignalsServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = OrderTrackingSignalsServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + transports.OrderTrackingSignalsServiceRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_kind_grpc(): + transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_order_tracking_signal_empty_call_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + call.return_value = order_tracking_signals.OrderTrackingSignal() + client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = OrderTrackingSignalsServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_create_order_tracking_signal_empty_call_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + )) + await client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = OrderTrackingSignalsServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_create_order_tracking_signal_rest_bad_request(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {'parent': 'accounts/sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = '' + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.create_order_tracking_signal(request) + + +@pytest.mark.parametrize("request_type", [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, +]) +def test_create_order_tracking_signal_rest_call_success(request_type): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'accounts/sample1'} + request_init["order_tracking_signal"] = {'order_tracking_signal_id': 2519, 'merchant_id': 1150, 'order_created_time': {'year': 433, 'month': 550, 'day': 318, 'hours': 561, 'minutes': 773, 'seconds': 751, 'nanos': 543, 'utc_offset': {'seconds': 751, 'nanos': 543}, 'time_zone': {'id': 'id_value', 'version': 'version_value'}}, 'order_id': 'order_id_value', 'shipping_info': [{'shipment_id': 'shipment_id_value', 'tracking_id': 'tracking_id_value', 'carrier': 'carrier_value', 'carrier_service': 'carrier_service_value', 'shipped_time': {}, 'earliest_delivery_promise_time': {}, 'latest_delivery_promise_time': {}, 'actual_delivery_time': {}, 'shipping_status': 1, 'origin_postal_code': 'origin_postal_code_value', 'origin_region_code': 'origin_region_code_value'}], 'line_items': [{'line_item_id': 'line_item_id_value', 'product_id': 'product_id_value', 'gtin': 'gtin_value', 'mpn': 'mpn_value', 'product_title': 'product_title_value', 'brand': 'brand_value', 'quantity': 895}], 'shipment_line_item_mapping': [{'shipment_id': 'shipment_id_value', 'line_item_id': 'line_item_id_value', 'quantity': 895}], 'customer_shipping_fee': {'amount_micros': 1408, 'currency_code': 'currency_code_value'}, 'delivery_postal_code': 'delivery_postal_code_value', 'delivery_region_code': 'delivery_region_code_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = order_tracking_signals.CreateOrderTrackingSignalRequest.meta.fields["order_tracking_signal"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["order_tracking_signal"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["order_tracking_signal"][field])): + del request_init["order_tracking_signal"][field][i][subfield] + else: + del request_init["order_tracking_signal"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id='order_id_value', + delivery_postal_code='delivery_postal_code_value', + delivery_region_code='delivery_region_code_value', + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode('UTF-8') + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.create_order_tracking_signal(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, order_tracking_signals.OrderTrackingSignal) + assert response.order_tracking_signal_id == 2519 + assert response.merchant_id == 1150 + assert response.order_id == 'order_id_value' + assert response.delivery_postal_code == 'delivery_postal_code_value' + assert response.delivery_region_code == 'delivery_region_code_value' + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_order_tracking_signal_rest_interceptors(null_interceptor): + transport = transports.OrderTrackingSignalsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OrderTrackingSignalsServiceRestInterceptor(), + ) + client = OrderTrackingSignalsServiceClient(transport=transport) + + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal") as post, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal_with_metadata") as post_with_metadata, \ + mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "pre_create_order_tracking_signal") as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(order_tracking_signals.CreateOrderTrackingSignalRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = order_tracking_signals.OrderTrackingSignal.to_json(order_tracking_signals.OrderTrackingSignal()) + req.return_value.content = return_value + + request = order_tracking_signals.CreateOrderTrackingSignalRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = order_tracking_signals.OrderTrackingSignal() + post_with_metadata.return_value = order_tracking_signals.OrderTrackingSignal(), metadata + + client.create_order_tracking_signal(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + +def test_initialize_client_w_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_create_order_tracking_signal_empty_call_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_order_tracking_signal), + '__call__') as call: + client.create_order_tracking_signal(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.OrderTrackingSignalsServiceGrpcTransport, + ) + +def test_order_tracking_signals_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.OrderTrackingSignalsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_order_tracking_signals_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.OrderTrackingSignalsServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_order_tracking_signal', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_order_tracking_signals_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OrderTrackingSignalsServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + quota_project_id="octopus", + ) + + +def test_order_tracking_signals_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OrderTrackingSignalsServiceTransport() + adc.assert_called_once() + + +def test_order_tracking_signals_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + OrderTrackingSignalsServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ], +) +def test_order_tracking_signals_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/content',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + transports.OrderTrackingSignalsServiceRestTransport, + ], +) +def test_order_tracking_signals_service_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.OrderTrackingSignalsServiceGrpcTransport, grpc_helpers), + (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_order_tracking_signals_service_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/content', +), + scopes=["1", "2"], + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_order_tracking_signals_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.OrderTrackingSignalsServiceRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_order_tracking_signals_service_host_no_port(transport_name): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'merchantapi.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://merchantapi.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_order_tracking_signals_service_host_with_port(transport_name): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'merchantapi.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://merchantapi.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_order_tracking_signals_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = OrderTrackingSignalsServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = OrderTrackingSignalsServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_order_tracking_signal._session + session2 = client2.transport.create_order_tracking_signal._session + assert session1 != session2 +def test_order_tracking_signals_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OrderTrackingSignalsServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_order_tracking_signals_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +def test_order_tracking_signals_service_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_account_path(): + account = "squid" + expected = "accounts/{account}".format(account=account, ) + actual = OrderTrackingSignalsServiceClient.account_path(account) + assert expected == actual + + +def test_parse_account_path(): + expected = { + "account": "clam", + } + path = OrderTrackingSignalsServiceClient.account_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_account_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "whelk" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = OrderTrackingSignalsServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "octopus", + } + path = OrderTrackingSignalsServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "oyster" + expected = "folders/{folder}".format(folder=folder, ) + actual = OrderTrackingSignalsServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nudibranch", + } + path = OrderTrackingSignalsServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "cuttlefish" + expected = "organizations/{organization}".format(organization=organization, ) + actual = OrderTrackingSignalsServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "mussel", + } + path = OrderTrackingSignalsServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "winkle" + expected = "projects/{project}".format(project=project, ) + actual = OrderTrackingSignalsServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "nautilus", + } + path = OrderTrackingSignalsServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "scallop" + location = "abalone" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = OrderTrackingSignalsServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "squid", + "location": "clam", + } + path = OrderTrackingSignalsServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = OrderTrackingSignalsServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = OrderTrackingSignalsServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc" + ) + with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = OrderTrackingSignalsServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio" + ) + with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest" + ) + with mock.patch.object(type(getattr(client.transport, "_session")), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = OrderTrackingSignalsServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport), + (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) From 3cfbe92c3d0fa4e7338b366cb2fe9b75375cd219 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 5 Aug 2025 13:12:18 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../v1/.coveragerc | 13 - .../v1/.flake8 | 34 - .../v1/LICENSE | 202 -- .../v1/MANIFEST.in | 20 - .../v1/README.rst | 143 -- .../v1/docs/_static/custom.css | 20 - .../v1/docs/_templates/layout.html | 50 - .../v1/docs/conf.py | 385 --- .../v1/docs/index.rst | 10 - .../v1/docs/multiprocessing.rst | 7 - .../merchant_ordertracking/__init__.py | 31 - .../gapic_version.py | 16 - .../merchant_ordertracking_v1/py.typed | 2 - .../transports/__init__.py | 38 - .../types/__init__.py | 24 - .../v1/mypy.ini | 3 - .../v1/noxfile.py | 591 ----- .../v1/setup.py | 99 - .../v1/testing/constraints-3.10.txt | 7 - .../v1/testing/constraints-3.11.txt | 7 - .../v1/testing/constraints-3.12.txt | 7 - .../v1/testing/constraints-3.13.txt | 12 - .../v1/testing/constraints-3.7.txt | 11 - .../v1/testing/constraints-3.8.txt | 7 - .../v1/testing/constraints-3.9.txt | 7 - .../v1/tests/__init__.py | 16 - .../v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../merchant_ordertracking_v1/__init__.py | 16 - .../v1beta/.coveragerc | 13 - .../v1beta/.flake8 | 34 - .../v1beta/LICENSE | 202 -- .../v1beta/MANIFEST.in | 20 - .../v1beta/README.rst | 143 -- .../v1beta/docs/_static/custom.css | 20 - .../v1beta/docs/_templates/layout.html | 50 - .../v1beta/docs/conf.py | 385 --- .../v1beta/docs/index.rst | 10 - .../order_tracking_signals_service.rst | 6 - .../services_.rst | 6 - .../merchant_ordertracking_v1beta/types_.rst | 6 - .../v1beta/docs/multiprocessing.rst | 7 - .../merchant_ordertracking/__init__.py | 31 - .../merchant_ordertracking/gapic_version.py | 16 - .../shopping/merchant_ordertracking/py.typed | 2 - .../merchant_ordertracking_v1beta/__init__.py | 32 - .../gapic_metadata.json | 43 - .../gapic_version.py | 16 - .../merchant_ordertracking_v1beta/py.typed | 2 - .../__init__.py | 22 - .../async_client.py | 396 --- .../order_tracking_signals_service/client.py | 756 ------ .../transports/README.rst | 9 - .../transports/base.py | 159 -- .../transports/grpc.py | 346 --- .../transports/grpc_asyncio.py | 367 --- .../transports/rest.py | 361 --- .../transports/rest_base.py | 138 - .../types/order_tracking_signals.py | 375 --- .../v1beta/mypy.ini | 3 - .../v1beta/noxfile.py | 591 ----- ...vice_create_order_tracking_signal_async.py | 63 - ...rvice_create_order_tracking_signal_sync.py | 63 - ...hopping.merchant.ordertracking.v1beta.json | 184 -- ..._merchant_ordertracking_v1beta_keywords.py | 176 -- .../v1beta/setup.py | 99 - .../v1beta/testing/constraints-3.10.txt | 7 - .../v1beta/testing/constraints-3.11.txt | 7 - .../v1beta/testing/constraints-3.12.txt | 7 - .../v1beta/testing/constraints-3.13.txt | 12 - .../v1beta/testing/constraints-3.7.txt | 11 - .../v1beta/testing/constraints-3.8.txt | 7 - .../v1beta/testing/constraints-3.9.txt | 7 - .../v1beta/tests/__init__.py | 16 - .../v1beta/tests/unit/__init__.py | 16 - .../v1beta/tests/unit/gapic/__init__.py | 16 - .../merchant_ordertracking_v1beta/__init__.py | 16 - .../test_order_tracking_signals_service.py | 2243 ----------------- .../docs/index.rst | 11 + .../order_tracking_signals_service.rst | 0 .../merchant_ordertracking_v1/services_.rst | 0 .../docs/merchant_ordertracking_v1/types_.rst | 0 .../merchant_ordertracking_v1/__init__.py | 21 +- .../gapic_metadata.json | 0 .../gapic_version.py | 0 .../merchant_ordertracking_v1}/py.typed | 0 .../services/__init__.py | 0 .../__init__.py | 6 +- .../async_client.py | 181 +- .../order_tracking_signals_service/client.py | 341 ++- .../transports/README.rst | 0 .../transports/__init__.py | 27 +- .../transports/base.py | 95 +- .../transports/grpc.py | 107 +- .../transports/grpc_asyncio.py | 119 +- .../transports/rest.py | 248 +- .../transports/rest_base.py | 86 +- .../types/__init__.py | 4 +- .../types/order_tracking_signals.py | 23 +- ...vice_create_order_tracking_signal_async.py | 0 ...rvice_create_order_tracking_signal_sync.py | 0 ...le.shopping.merchant.ordertracking.v1.json | 0 ...ixup_merchant_ordertracking_v1_keywords.py | 0 .../merchant_ordertracking_v1}/__init__.py | 0 .../test_order_tracking_signals_service.py | 1682 ++++++++---- 105 files changed, 1971 insertions(+), 10307 deletions(-) delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py delete mode 100644 owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/docs/merchant_ordertracking_v1/services_.rst (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/docs/merchant_ordertracking_v1/types_.rst (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/__init__.py (61%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/gapic_metadata.json (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking => packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1}/gapic_version.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking => packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1}/py.typed (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/__init__.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py (89%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py (78%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py (76%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta => packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1}/services/order_tracking_signals_service/transports/__init__.py (58%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py (69%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py (85%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py (83%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py (67%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py (67%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta => packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1}/types/__init__.py (91%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py (96%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/scripts/fixup_merchant_ordertracking_v1_keywords.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services => packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1}/__init__.py (100%) rename {owl-bot-staging/google-shopping-merchant-ordertracking/v1 => packages/google-shopping-merchant-ordertracking}/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py (63%) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc deleted file mode 100644 index c02611dc5807..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/shopping/merchant_ordertracking/__init__.py - google/shopping/merchant_ordertracking/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 deleted file mode 100644 index 90316de21489..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/.flake8 +++ /dev/null @@ -1,34 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -[flake8] -# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): -# Resolve flake8 lint issues -ignore = E203, E231, E266, E501, W503 -exclude = - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): - # Ensure that generated code passes flake8 lint - **/gapic/** - **/services/** - **/types/** - # Exclude Protobuf gencode - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE deleted file mode 100644 index d64569567334..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in deleted file mode 100644 index dae249ec8976..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/MANIFEST.in +++ /dev/null @@ -1,20 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -include README.rst LICENSE -recursive-include google *.py *.pyi *.json *.proto py.typed -recursive-include tests * -global-exclude *.py[co] -global-exclude __pycache__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst deleted file mode 100644 index c4e23cfbdc21..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/README.rst +++ /dev/null @@ -1,143 +0,0 @@ -Python Client for Google Shopping Merchant Ordertracking API -================================================= - -Quick Start ------------ - -In order to use this library, you first need to go through the following steps: - -1. `Select or create a Cloud Platform project.`_ -2. `Enable billing for your project.`_ -3. Enable the Google Shopping Merchant Ordertracking API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library - - -Logging -------- - -This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. -Note the following: - -#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. -#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. -#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. - - -Simple, environment-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google -logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged -messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging -event. - -A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. - -- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. -- Invalid logging scopes: :code:`foo`, :code:`123`, etc. - -**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. - - -Examples -^^^^^^^^ - -- Enabling the default handler for all Google-based loggers - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google - -- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 - - -Advanced, code-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can also configure a valid logging scope using Python's standard `logging` mechanism. - - -Examples -^^^^^^^^ - -- Configuring a handler for all Google-based loggers - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - -- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google.cloud.library_v1") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - - -Logging details -~~~~~~~~~~~~~~~ - -#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root - logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set - :code:`logging.getLogger("google").propagate = True` in your code. -#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for - one library, but decide you need to also set up environment-based logging configuration for another library. - - #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual - if the code -based configuration gets applied first. - -#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get - executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. - (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css deleted file mode 100644 index b0a295464b23..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_static/custom.css +++ /dev/null @@ -1,20 +0,0 @@ -div#python2-eol { - border-color: red; - border-width: medium; -} - -/* Ensure minimum width for 'Parameters' / 'Returns' column */ -dl.field-list > dt { - min-width: 100px -} - -/* Insert space between methods for readability */ -dl.method { - padding-top: 10px; - padding-bottom: 10px -} - -/* Insert empty space between classes */ -dl.class { - padding-bottom: 50px -} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html deleted file mode 100644 index 95e9c77fcfe1..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/_templates/layout.html +++ /dev/null @@ -1,50 +0,0 @@ - -{% extends "!layout.html" %} -{%- block content %} -{%- if theme_fixed_sidebar|lower == 'true' %} -
- {{ sidebar() }} - {%- block document %} -
- {%- if render_sidebar %} -
- {%- endif %} - - {%- block relbar_top %} - {%- if theme_show_relbar_top|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - -
-
- As of January 1, 2020 this library no longer supports Python 2 on the latest released version. - Library versions released prior to that date will continue to be available. For more information please - visit Python 2 support on Google Cloud. -
- {% block body %} {% endblock %} -
- - {%- block relbar_bottom %} - {%- if theme_show_relbar_bottom|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - - {%- if render_sidebar %} -
- {%- endif %} -
- {%- endblock %} -
-
-{%- else %} -{{ super() }} -{%- endif %} -{%- endblock %} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py deleted file mode 100644 index 7a8d49f67478..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/conf.py +++ /dev/null @@ -1,385 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -# -# google-shopping-merchant-ordertracking documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -# For plugins that can not read conf.py. -# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 -sys.path.insert(0, os.path.abspath(".")) - -__version__ = "" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.5.0" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.doctest", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", - "recommonmark", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_options = {"members": True} -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-shopping-merchant-ordertracking" -copyright = u"2025, Google, LLC" -author = u"Google APIs" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [ - "_build", - "**/.nox/**/*", - "samples/AUTHORING_GUIDE.md", - "samples/CONTRIBUTING.md", - "samples/snippets/README.rst", -] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Shopping Client Libraries for google-shopping-merchant-ordertracking", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-shopping-merchant-ordertracking-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - root_doc, - "google-shopping-merchant-ordertracking.tex", - u"google-shopping-merchant-ordertracking Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - root_doc, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - root_doc, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Documentation", - author, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Library", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "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.github.io/grpc/python/", None), - "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst deleted file mode 100644 index 6d1e4e37544c..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. include:: multiprocessing.rst - - -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - merchant_ordertracking_v1/services_ - merchant_ordertracking_v1/types_ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst deleted file mode 100644 index 536d17b2ea65..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/multiprocessing.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - Because this client uses :mod:`grpc` library, it is safe to - share instances across threads. In multiprocessing scenarios, the best - practice is to create client instances *after* the invocation of - :func:`os.fork` by :class:`multiprocessing.pool.Pool` or - :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py deleted file mode 100644 index 0727b57c595e..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/__init__.py +++ /dev/null @@ -1,31 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.shopping.merchant_ordertracking import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.client import OrderTrackingSignalsServiceClient -from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.async_client import OrderTrackingSignalsServiceAsyncClient - -from google.shopping.merchant_ordertracking_v1.types.order_tracking_signals import CreateOrderTrackingSignalRequest -from google.shopping.merchant_ordertracking_v1.types.order_tracking_signals import OrderTrackingSignal - -__all__ = ('OrderTrackingSignalsServiceClient', - 'OrderTrackingSignalsServiceAsyncClient', - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py deleted file mode 100644 index 20a9cd975b02..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed deleted file mode 100644 index 24d3a8286bc4..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py deleted file mode 100644 index c1246dfdc064..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 collections import OrderedDict -from typing import Dict, Type - -from .base import OrderTrackingSignalsServiceTransport -from .grpc import OrderTrackingSignalsServiceGrpcTransport -from .grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport -from .rest import OrderTrackingSignalsServiceRestTransport -from .rest import OrderTrackingSignalsServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] -_transport_registry['grpc'] = OrderTrackingSignalsServiceGrpcTransport -_transport_registry['grpc_asyncio'] = OrderTrackingSignalsServiceGrpcAsyncIOTransport -_transport_registry['rest'] = OrderTrackingSignalsServiceRestTransport - -__all__ = ( - 'OrderTrackingSignalsServiceTransport', - 'OrderTrackingSignalsServiceGrpcTransport', - 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', - 'OrderTrackingSignalsServiceRestTransport', - 'OrderTrackingSignalsServiceRestInterceptor', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py deleted file mode 100644 index d1e7569d2768..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/__init__.py +++ /dev/null @@ -1,24 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 .order_tracking_signals import ( - CreateOrderTrackingSignalRequest, - OrderTrackingSignal, -) - -__all__ = ( - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py deleted file mode 100644 index 5a16b31cc051..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/noxfile.py +++ /dev/null @@ -1,591 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import os -import pathlib -import re -import shutil - -from typing import Dict, List -import warnings - -import nox - -BLACK_VERSION = "black[jupyter]==23.7.0" -ISORT_VERSION = "isort==5.11.0" - -LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", - "3.12", - "3.13", -] - -DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = "google-shopping-merchant-ordertracking" - -UNIT_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "asyncmock", - "pytest", - "pytest-cov", - "pytest-asyncio", -] -UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_DEPENDENCIES: List[str] = [] -UNIT_TEST_EXTRAS: List[str] = [] -UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] -SYSTEM_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "pytest", - "google-cloud-testutils", -] -SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_EXTRAS: List[str] = [] -SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -nox.options.sessions = [ - "unit", - "system", - "cover", - "lint", - "lint_setup_py", - "blacken", - "docs", -] - -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - "mypy", - "types-requests", - "types-protobuf", - ) - session.install(".") - session.run( - "mypy", - "-p", - "google", - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install("google-cloud-testutils") - session.install(".") - - session.run( - "lower-bound-checker", - "update", - "--package-name", - PACKAGE_NAME, - "--constraints-file", - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install("google-cloud-testutils") - session.install(".") - - session.run( - "lower-bound-checker", - "check", - "--package-name", - PACKAGE_NAME, - "--constraints-file", - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *LINT_PATHS, - ) - - session.run("flake8", "google", "tests") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def format(session): - """ - Run isort to sort imports. Then run black - to format code to uniform standard. - """ - session.install(BLACK_VERSION, ISORT_VERSION) - # Use the --fss option to sort imports using strict alphabetical order. - # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections - session.run( - "isort", - "--fss", - *LINT_PATHS, - ) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("setuptools", "docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") - - -def install_unittest_dependencies(session, *constraints): - standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES - session.install(*standard_deps, *constraints) - - if UNIT_TEST_EXTERNAL_DEPENDENCIES: - warnings.warn( - "'unit_test_external_dependencies' is deprecated. Instead, please " - "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", - DeprecationWarning, - ) - session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_LOCAL_DEPENDENCIES: - session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_EXTRAS_BY_PYTHON: - extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif UNIT_TEST_EXTRAS: - extras = UNIT_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=ALL_PYTHON) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def unit(session, protobuf_implementation): - # Install all test dependencies, then install this package in-place. - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - install_unittest_dependencies(session, "-c", constraints_path) - - # TODO(https://github.com/googleapis/synthtool/issues/1976): - # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. - # The 'cpp' implementation requires Protobuf<4. - if protobuf_implementation == "cpp": - session.install("protobuf<4") - - # Run py.test against the unit tests. - session.run( - "py.test", - "--quiet", - f"--junitxml=unit_{session.python}_sponge_log.xml", - "--cov=google", - "--cov=tests/unit", - "--cov-append", - "--cov-config=.coveragerc", - "--cov-report=", - "--cov-fail-under=0", - os.path.join("tests", "unit"), - *session.posargs, - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -def install_systemtest_dependencies(session, *constraints): - session.install("--pre", "grpcio") - - session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: - session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_LOCAL_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTRAS_BY_PYTHON: - extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif SYSTEM_TEST_EXTRAS: - extras = SYSTEM_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) -def system(session): - """Run the system test suite.""" - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - system_test_path = os.path.join("tests", "system.py") - system_test_folder_path = os.path.join("tests", "system") - - # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. - if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": - session.skip("RUN_SYSTEM_TESTS is set to false, skipping") - # Install pyopenssl for mTLS testing. - if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": - session.install("pyopenssl") - - system_test_exists = os.path.exists(system_test_path) - system_test_folder_exists = os.path.exists(system_test_folder_path) - # Sanity check: only run tests if found. - if not system_test_exists and not system_test_folder_exists: - session.skip("System tests were not found") - - install_systemtest_dependencies(session, "-c", constraints_path) - - # Run py.test against the system tests. - if system_test_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_path, - *session.posargs, - ) - if system_test_folder_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_folder_path, - *session.posargs, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python="3.10") -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "sphinx==4.5.0", - "alabaster", - "recommonmark", - ) - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python="3.10") -def docfx(session): - """Build the docfx yaml files for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "gcp-sphinx-docfx-yaml", - "alabaster", - "recommonmark", - ) - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-T", # show full traceback on exception - "-N", # no colors - "-D", - ( - "extensions=sphinx.ext.autodoc," - "sphinx.ext.autosummary," - "docfx_yaml.extension," - "sphinx.ext.intersphinx," - "sphinx.ext.coverage," - "sphinx.ext.napoleon," - "sphinx.ext.todo," - "sphinx.ext.viewcode," - "recommonmark" - ), - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def prerelease_deps(session, protobuf_implementation): - """ - Run all tests with pre-release versions of dependencies installed - rather than the standard non pre-release versions. - Pre-release versions can be installed using - `pip install --pre `. - """ - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # Note: If a dependency is added to the `prerel_deps` list, - # the `core_dependencies_from_source` list in the `core_deps_from_source` - # nox session should also be updated. - prerel_deps = [ - "googleapis-common-protos", - "google-api-core", - "google-auth", - "grpc-google-iam-v1", - "grpcio", - "grpcio-status", - "protobuf", - "proto-plus", - ] - - for dep in prerel_deps: - session.install("--pre", "--no-deps", "--ignore-installed", dep) - # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` - # to the dictionary below once this bug is fixed. - # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add - # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below - # once this bug is fixed. - package_namespaces = { - "google-api-core": "google.api_core", - "google-auth": "google.auth", - "grpcio": "grpc", - "protobuf": "google.protobuf", - "proto-plus": "proto", - } - - version_namespace = package_namespaces.get(dep) - - print(f"Installed {dep}") - if version_namespace: - session.run( - "python", - "-c", - f"import {version_namespace}; print({version_namespace}.__version__)", - ) - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb"], -) -def core_deps_from_source(session, protobuf_implementation): - """Run all tests with core dependencies installed from source - rather than pulling the dependencies from PyPI. - """ - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and - # `grpcio-status` should be added to the list below so that they are installed from source, - # rather than PyPI. - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be - # added to the list below so that it is installed from source, rather than PyPI - # Note: If a dependency is added to the `core_dependencies_from_source` list, - # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. - core_dependencies_from_source = [ - "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", - "google-api-core @ git+https://github.com/googleapis/python-api-core.git", - "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", - "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", - "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", - ] - - for dep in core_dependencies_from_source: - session.install(dep, "--no-deps", "--ignore-installed") - print(f"Installed {dep}") - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py deleted file mode 100644 index 44b1307169b0..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/setup.py +++ /dev/null @@ -1,99 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import io -import os -import re - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-shopping-merchant-ordertracking' - - -description = "Google Shopping Merchant Ordertracking API client library" - -version = None - -with open(os.path.join(package_root, 'google/shopping/merchant_ordertracking/gapic_version.py')) as fp: - version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) - assert (len(version_candidates) == 1) - version = version_candidates[0] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - # Exclude incompatible versions of `google-auth` - # See https://github.com/googleapis/google-cloud-python/issues/12364 - "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", - "proto-plus >= 1.22.3, <2.0.0", - "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", - "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", - "google-shopping-type >= 0.1.6, <1.0.0", -] -extras = { -} -url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-shopping-merchant-ordertracking" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.find_namespace_packages() - if package.startswith("google") -] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Programming Language :: Python :: 3.13", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - install_requires=dependencies, - extras_require=extras, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt deleted file mode 100644 index 0112695e5bbb..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.13.txt +++ /dev/null @@ -1,12 +0,0 @@ -# We use the constraints file for the latest Python version -# (currently this file) to check that the latest -# major versions of dependencies are supported in setup.py. -# List all library dependencies and extras in this file. -# Require the latest major version be installed for each dependency. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", -# Then this file should have google-cloud-foo>=1 -google-api-core>=2 -google-auth>=2 -proto-plus>=1 -protobuf>=6 -google-shopping-type>=0 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt deleted file mode 100644 index 2af887ec8ba0..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,11 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.1 -google-auth==2.14.1 -proto-plus==1.22.3 -protobuf==3.20.2 -google-shopping-type==0.1.6 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc deleted file mode 100644 index c02611dc5807..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/shopping/merchant_ordertracking/__init__.py - google/shopping/merchant_ordertracking/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 deleted file mode 100644 index 90316de21489..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/.flake8 +++ /dev/null @@ -1,34 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -[flake8] -# TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): -# Resolve flake8 lint issues -ignore = E203, E231, E266, E501, W503 -exclude = - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2333): - # Ensure that generated code passes flake8 lint - **/gapic/** - **/services/** - **/types/** - # Exclude Protobuf gencode - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE deleted file mode 100644 index d64569567334..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/LICENSE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in deleted file mode 100644 index dae249ec8976..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/MANIFEST.in +++ /dev/null @@ -1,20 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -include README.rst LICENSE -recursive-include google *.py *.pyi *.json *.proto py.typed -recursive-include tests * -global-exclude *.py[co] -global-exclude __pycache__ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst deleted file mode 100644 index c4e23cfbdc21..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/README.rst +++ /dev/null @@ -1,143 +0,0 @@ -Python Client for Google Shopping Merchant Ordertracking API -================================================= - -Quick Start ------------ - -In order to use this library, you first need to go through the following steps: - -1. `Select or create a Cloud Platform project.`_ -2. `Enable billing for your project.`_ -3. Enable the Google Shopping Merchant Ordertracking API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library - - -Logging -------- - -This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes. -Note the following: - -#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging. -#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**. -#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below. - - -Simple, environment-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google -logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged -messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging -event. - -A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log. - -- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc. -- Invalid logging scopes: :code:`foo`, :code:`123`, etc. - -**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers. - - -Examples -^^^^^^^^ - -- Enabling the default handler for all Google-based loggers - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google - -- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: console - - export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1 - - -Advanced, code-based configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can also configure a valid logging scope using Python's standard `logging` mechanism. - - -Examples -^^^^^^^^ - -- Configuring a handler for all Google-based loggers - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - -- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`): - -.. code-block:: python - - import logging - - from google.cloud.translate_v3 import translate - - base_logger = logging.getLogger("google.cloud.library_v1") - base_logger.addHandler(logging.StreamHandler()) - base_logger.setLevel(logging.DEBUG) - - -Logging details -~~~~~~~~~~~~~~~ - -#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root - logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set - :code:`logging.getLogger("google").propagate = True` in your code. -#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for - one library, but decide you need to also set up environment-based logging configuration for another library. - - #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual - if the code -based configuration gets applied first. - -#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get - executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured. - (This is the reason for 2.i. above.) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css deleted file mode 100644 index b0a295464b23..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_static/custom.css +++ /dev/null @@ -1,20 +0,0 @@ -div#python2-eol { - border-color: red; - border-width: medium; -} - -/* Ensure minimum width for 'Parameters' / 'Returns' column */ -dl.field-list > dt { - min-width: 100px -} - -/* Insert space between methods for readability */ -dl.method { - padding-top: 10px; - padding-bottom: 10px -} - -/* Insert empty space between classes */ -dl.class { - padding-bottom: 50px -} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html deleted file mode 100644 index 95e9c77fcfe1..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/_templates/layout.html +++ /dev/null @@ -1,50 +0,0 @@ - -{% extends "!layout.html" %} -{%- block content %} -{%- if theme_fixed_sidebar|lower == 'true' %} -
- {{ sidebar() }} - {%- block document %} -
- {%- if render_sidebar %} -
- {%- endif %} - - {%- block relbar_top %} - {%- if theme_show_relbar_top|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - -
-
- As of January 1, 2020 this library no longer supports Python 2 on the latest released version. - Library versions released prior to that date will continue to be available. For more information please - visit Python 2 support on Google Cloud. -
- {% block body %} {% endblock %} -
- - {%- block relbar_bottom %} - {%- if theme_show_relbar_bottom|tobool %} -
-   - {{- rellink_markup () }} -
- {%- endif %} - {% endblock %} - - {%- if render_sidebar %} -
- {%- endif %} -
- {%- endblock %} -
-
-{%- else %} -{{ super() }} -{%- endif %} -{%- endblock %} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py deleted file mode 100644 index 7a8d49f67478..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/conf.py +++ /dev/null @@ -1,385 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -# -# google-shopping-merchant-ordertracking documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -# For plugins that can not read conf.py. -# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85 -sys.path.insert(0, os.path.abspath(".")) - -__version__ = "" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.5.0" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.doctest", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", - "recommonmark", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_options = {"members": True} -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-shopping-merchant-ordertracking" -copyright = u"2025, Google, LLC" -author = u"Google APIs" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [ - "_build", - "**/.nox/**/*", - "samples/AUTHORING_GUIDE.md", - "samples/CONTRIBUTING.md", - "samples/snippets/README.rst", -] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Shopping Client Libraries for google-shopping-merchant-ordertracking", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-shopping-merchant-ordertracking-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - root_doc, - "google-shopping-merchant-ordertracking.tex", - u"google-shopping-merchant-ordertracking Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - root_doc, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - root_doc, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Documentation", - author, - "google-shopping-merchant-ordertracking", - "google-shopping-merchant-ordertracking Library", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "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.github.io/grpc/python/", None), - "proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst deleted file mode 100644 index 8ae1a3476cff..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. include:: multiprocessing.rst - - -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - merchant_ordertracking_v1beta/services_ - merchant_ordertracking_v1beta/types_ diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst deleted file mode 100644 index 8ea4ebe68d44..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/order_tracking_signals_service.rst +++ /dev/null @@ -1,6 +0,0 @@ -OrderTrackingSignalsService ---------------------------------------------- - -.. automodule:: google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service - :members: - :inherited-members: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst deleted file mode 100644 index 9088106ddfc9..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/services_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Shopping Merchant Ordertracking v1beta API -============================================================== -.. toctree:: - :maxdepth: 2 - - order_tracking_signals_service diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst deleted file mode 100644 index 3eba5dd686ac..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/merchant_ordertracking_v1beta/types_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Shopping Merchant Ordertracking v1beta API -=========================================================== - -.. automodule:: google.shopping.merchant_ordertracking_v1beta.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst deleted file mode 100644 index 536d17b2ea65..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/docs/multiprocessing.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - Because this client uses :mod:`grpc` library, it is safe to - share instances across threads. In multiprocessing scenarios, the best - practice is to create client instances *after* the invocation of - :func:`os.fork` by :class:`multiprocessing.pool.Pool` or - :class:`multiprocessing.Process`. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py deleted file mode 100644 index 2a36e786e848..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/__init__.py +++ /dev/null @@ -1,31 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.shopping.merchant_ordertracking import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.client import OrderTrackingSignalsServiceClient -from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.async_client import OrderTrackingSignalsServiceAsyncClient - -from google.shopping.merchant_ordertracking_v1beta.types.order_tracking_signals import CreateOrderTrackingSignalRequest -from google.shopping.merchant_ordertracking_v1beta.types.order_tracking_signals import OrderTrackingSignal - -__all__ = ('OrderTrackingSignalsServiceClient', - 'OrderTrackingSignalsServiceAsyncClient', - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py deleted file mode 100644 index 20a9cd975b02..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed deleted file mode 100644 index 24d3a8286bc4..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py deleted file mode 100644 index b801bfe2f1fb..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/__init__.py +++ /dev/null @@ -1,32 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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.shopping.merchant_ordertracking_v1beta import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.order_tracking_signals_service import OrderTrackingSignalsServiceClient -from .services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient - -from .types.order_tracking_signals import CreateOrderTrackingSignalRequest -from .types.order_tracking_signals import OrderTrackingSignal - -__all__ = ( - 'OrderTrackingSignalsServiceAsyncClient', -'CreateOrderTrackingSignalRequest', -'OrderTrackingSignal', -'OrderTrackingSignalsServiceClient', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json deleted file mode 100644 index d3d8eed6c4b5..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_metadata.json +++ /dev/null @@ -1,43 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.shopping.merchant_ordertracking_v1beta", - "protoPackage": "google.shopping.merchant.ordertracking.v1beta", - "schema": "1.0", - "services": { - "OrderTrackingSignalsService": { - "clients": { - "grpc": { - "libraryClient": "OrderTrackingSignalsServiceClient", - "rpcs": { - "CreateOrderTrackingSignal": { - "methods": [ - "create_order_tracking_signal" - ] - } - } - }, - "grpc-async": { - "libraryClient": "OrderTrackingSignalsServiceAsyncClient", - "rpcs": { - "CreateOrderTrackingSignal": { - "methods": [ - "create_order_tracking_signal" - ] - } - } - }, - "rest": { - "libraryClient": "OrderTrackingSignalsServiceClient", - "rpcs": { - "CreateOrderTrackingSignal": { - "methods": [ - "create_order_tracking_signal" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py deleted file mode 100644 index 20a9cd975b02..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed deleted file mode 100644 index 24d3a8286bc4..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-shopping-merchant-ordertracking package uses inline types. diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py deleted file mode 100644 index 15b29929ccad..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 .client import OrderTrackingSignalsServiceClient -from .async_client import OrderTrackingSignalsServiceAsyncClient - -__all__ = ( - 'OrderTrackingSignalsServiceClient', - 'OrderTrackingSignalsServiceAsyncClient', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py deleted file mode 100644 index 8afb2b1c5636..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/async_client.py +++ /dev/null @@ -1,396 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import logging as std_logging -from collections import OrderedDict -import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore -import google.protobuf - - -try: - OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals -from google.shopping.type.types import types -from google.type import datetime_pb2 # type: ignore -from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport -from .client import OrderTrackingSignalsServiceClient - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - -class OrderTrackingSignalsServiceAsyncClient: - """Service to serve order tracking signals public API.""" - - _client: OrderTrackingSignalsServiceClient - - # Copy defaults from the synchronous client for use here. - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - _DEFAULT_ENDPOINT_TEMPLATE = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE - _DEFAULT_UNIVERSE = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - - account_path = staticmethod(OrderTrackingSignalsServiceClient.account_path) - parse_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_account_path) - common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_organization_path) - common_project_path = staticmethod(OrderTrackingSignalsServiceClient.common_project_path) - parse_common_project_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_project_path) - common_location_path = staticmethod(OrderTrackingSignalsServiceClient.common_location_path) - parse_common_location_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_location_path) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - OrderTrackingSignalsServiceAsyncClient: The constructed client. - """ - return OrderTrackingSignalsServiceClient.from_service_account_info.__func__(OrderTrackingSignalsServiceAsyncClient, info, *args, **kwargs) # type: ignore - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - OrderTrackingSignalsServiceAsyncClient: The constructed client. - """ - return OrderTrackingSignalsServiceClient.from_service_account_file.__func__(OrderTrackingSignalsServiceAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - return OrderTrackingSignalsServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> OrderTrackingSignalsServiceTransport: - """Returns the transport used by the client instance. - - Returns: - OrderTrackingSignalsServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._client._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used - by the client instance. - """ - return self._client._universe_domain - - get_transport_class = OrderTrackingSignalsServiceClient.get_transport_class - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the order tracking signals service async client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport to use. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the OrderTrackingSignalsServiceTransport constructor. - If set to None, a transport is chosen automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): - Custom options for the client. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto-switch to the - default mTLS endpoint if client certificate is present; this is - the default value). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = OrderTrackingSignalsServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER - _LOGGER.debug( - "Created client `google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient`.", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), - "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._client._transport, "_credentials") else { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "credentialsType": None, - } - ) - - async def create_order_tracking_signal(self, - request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, - *, - parent: Optional[str] = None, - order_tracking_signal_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> order_tracking_signals.OrderTrackingSignal: - r"""Creates new order tracking signal. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.shopping import merchant_ordertracking_v1beta - - async def sample_create_order_tracking_signal(): - # Create a client - client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient() - - # Initialize request argument(s) - order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() - order_tracking_signal.order_id = "order_id_value" - order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" - order_tracking_signal.shipping_info.shipping_status = "DELIVERED" - order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" - order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" - order_tracking_signal.line_items.line_item_id = "line_item_id_value" - order_tracking_signal.line_items.product_id = "product_id_value" - order_tracking_signal.line_items.quantity = 895 - - request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( - parent="parent_value", - order_tracking_signal=order_tracking_signal, - ) - - # Make the request - response = await client.create_order_tracking_signal(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest, dict]]): - The request object. Signals only can be created but not - updated. Businesses need to call this - API only when the order is completely - shipped. Creates new order signal. - parent (:class:`str`): - Required. The account of the business - for which the order signal is created. - Format: accounts/{account} - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - order_tracking_signal_id (:class:`str`): - Output only. The ID that uniquely - identifies this order tracking signal. - - This corresponds to the ``order_tracking_signal_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal: - Represents a business trade from - which signals are extracted, such as - shipping. - - """ - # Create or coerce a protobuf request object. - # - Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - flattened_params = [parent, order_tracking_signal_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): - request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if order_tracking_signal_id is not None: - request.order_tracking_signal_id = order_tracking_signal_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_order_tracking_signal] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "OrderTrackingSignalsServiceAsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -__all__ = ( - "OrderTrackingSignalsServiceAsyncClient", -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py deleted file mode 100644 index 1fada41517e3..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/client.py +++ /dev/null @@ -1,756 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 collections import OrderedDict -from http import HTTPStatus -import json -import logging as std_logging -import os -import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast -import warnings - -from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore -import google.protobuf - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals -from google.shopping.type.types import types -from google.type import datetime_pb2 # type: ignore -from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import OrderTrackingSignalsServiceGrpcTransport -from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport -from .transports.rest import OrderTrackingSignalsServiceRestTransport - - -class OrderTrackingSignalsServiceClientMeta(type): - """Metaclass for the OrderTrackingSignalsService client. - - This provides class-level methods for building and retrieving - support objects (e.g. transport) without polluting the client instance - objects. - """ - _transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] - _transport_registry["grpc"] = OrderTrackingSignalsServiceGrpcTransport - _transport_registry["grpc_asyncio"] = OrderTrackingSignalsServiceGrpcAsyncIOTransport - _transport_registry["rest"] = OrderTrackingSignalsServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[OrderTrackingSignalsServiceTransport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class OrderTrackingSignalsServiceClient(metaclass=OrderTrackingSignalsServiceClientMeta): - """Service to serve order tracking signals public API.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = "merchantapi.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" - _DEFAULT_UNIVERSE = "googleapis.com" - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - OrderTrackingSignalsServiceClient: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_info(info) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - OrderTrackingSignalsServiceClient: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_file( - filename) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> OrderTrackingSignalsServiceTransport: - """Returns the transport used by the client instance. - - Returns: - OrderTrackingSignalsServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def account_path(account: str,) -> str: - """Returns a fully-qualified account string.""" - return "accounts/{account}".format(account=account, ) - - @staticmethod - def parse_account_path(path: str) -> Dict[str,str]: - """Parses a account path into its component segments.""" - m = re.match(r"^accounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Deprecated. Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - - warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", - DeprecationWarning) - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - @staticmethod - def _read_environment_variables(): - """Returns the environment variables used by the client. - - Returns: - Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, - GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. - - Raises: - ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not - any of ["true", "false"]. - google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT - is not any of ["auto", "never", "always"]. - """ - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() - universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - return use_client_cert == "true", use_mtls_endpoint, universe_domain_env - - @staticmethod - def _get_client_cert_source(provided_cert_source, use_cert_flag): - """Return the client cert source to be used by the client. - - Args: - provided_cert_source (bytes): The client certificate source provided. - use_cert_flag (bool): A flag indicating whether to use the client certificate. - - Returns: - bytes or None: The client cert source to be used by the client. - """ - client_cert_source = None - if use_cert_flag: - if provided_cert_source: - client_cert_source = provided_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - return client_cert_source - - @staticmethod - def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): - """Return the API endpoint used by the client. - - Args: - api_override (str): The API endpoint override. If specified, this is always - the return value of this function and the other arguments are not used. - client_cert_source (bytes): The client certificate source used by the client. - universe_domain (str): The universe domain used by the client. - use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. - Possible values are "always", "auto", or "never". - - Returns: - str: The API endpoint to be used by the client. - """ - if api_override is not None: - api_endpoint = api_override - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - _default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - if universe_domain != _default_universe: - raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") - api_endpoint = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) - return api_endpoint - - @staticmethod - def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: - """Return the universe domain used by the client. - - Args: - client_universe_domain (Optional[str]): The universe domain configured via the client options. - universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. - - Returns: - str: The universe domain to be used by the client. - - Raises: - ValueError: If the universe domain is an empty string. - """ - universe_domain = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - if client_universe_domain is not None: - universe_domain = client_universe_domain - elif universe_domain_env is not None: - universe_domain = universe_domain_env - if len(universe_domain.strip()) == 0: - raise ValueError("Universe Domain cannot be an empty string.") - return universe_domain - - def _validate_universe_domain(self): - """Validates client's and credentials' universe domains are consistent. - - Returns: - bool: True iff the configured universe domain is valid. - - Raises: - ValueError: If the configured universe domain is not valid. - """ - - # NOTE (b/349488459): universe validation is disabled until further notice. - return True - - def _add_cred_info_for_auth_errors( - self, - error: core_exceptions.GoogleAPICallError - ) -> None: - """Adds credential info string to error details for 401/403/404 errors. - - Args: - error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. - """ - if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: - return - - cred = self._transport._credentials - - # get_cred_info is only available in google-auth>=2.35.0 - if not hasattr(cred, "get_cred_info"): - return - - # ignore the type check since pypy test fails when get_cred_info - # is not available - cred_info = cred.get_cred_info() # type: ignore - if cred_info and hasattr(error._details, "append"): - error._details.append(json.dumps(cred_info)) - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used by the client instance. - """ - return self._universe_domain - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the order tracking signals service client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Optional[Union[str,OrderTrackingSignalsServiceTransport,Callable[..., OrderTrackingSignalsServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the OrderTrackingSignalsServiceTransport constructor. - If set to None, a transport is chosen automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): - Custom options for the client. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto-switch to the - default mTLS endpoint if client certificate is present; this is - the default value). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that the ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client_options = client_options - if isinstance(self._client_options, dict): - self._client_options = client_options_lib.from_dict(self._client_options) - if self._client_options is None: - self._client_options = client_options_lib.ClientOptions() - self._client_options = cast(client_options_lib.ClientOptions, self._client_options) - - universe_domain_opt = getattr(self._client_options, 'universe_domain', None) - - self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OrderTrackingSignalsServiceClient._read_environment_variables() - self._client_cert_source = OrderTrackingSignalsServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) - self._universe_domain = OrderTrackingSignalsServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) - self._api_endpoint = None # updated below, depending on `transport` - - # Initialize the universe domain validation. - self._is_universe_domain_valid = False - - if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER - # Setup logging. - client_logging.initialize_logging() - - api_key_value = getattr(self._client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - transport_provided = isinstance(transport, OrderTrackingSignalsServiceTransport) - if transport_provided: - # transport is a OrderTrackingSignalsServiceTransport instance. - if credentials or self._client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if self._client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = cast(OrderTrackingSignalsServiceTransport, transport) - self._api_endpoint = self._transport.host - - self._api_endpoint = (self._api_endpoint or - OrderTrackingSignalsServiceClient._get_api_endpoint( - self._client_options.api_endpoint, - self._client_cert_source, - self._universe_domain, - self._use_mtls_endpoint)) - - if not transport_provided: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - transport_init: Union[Type[OrderTrackingSignalsServiceTransport], Callable[..., OrderTrackingSignalsServiceTransport]] = ( - OrderTrackingSignalsServiceClient.get_transport_class(transport) - if isinstance(transport, str) or transport is None - else cast(Callable[..., OrderTrackingSignalsServiceTransport], transport) - ) - # initialize with the provided callable or the passed in class - self._transport = transport_init( - credentials=credentials, - credentials_file=self._client_options.credentials_file, - host=self._api_endpoint, - scopes=self._client_options.scopes, - client_cert_source_for_mtls=self._client_cert_source, - quota_project_id=self._client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=self._client_options.api_audience, - ) - - if "async" not in str(self._transport): - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER - _LOGGER.debug( - "Created client `google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient`.", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), - "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._transport, "_credentials") else { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "credentialsType": None, - } - ) - - def create_order_tracking_signal(self, - request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, - *, - parent: Optional[str] = None, - order_tracking_signal_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> order_tracking_signals.OrderTrackingSignal: - r"""Creates new order tracking signal. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.shopping import merchant_ordertracking_v1beta - - def sample_create_order_tracking_signal(): - # Create a client - client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient() - - # Initialize request argument(s) - order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() - order_tracking_signal.order_id = "order_id_value" - order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" - order_tracking_signal.shipping_info.shipping_status = "DELIVERED" - order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" - order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" - order_tracking_signal.line_items.line_item_id = "line_item_id_value" - order_tracking_signal.line_items.product_id = "product_id_value" - order_tracking_signal.line_items.quantity = 895 - - request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( - parent="parent_value", - order_tracking_signal=order_tracking_signal, - ) - - # Make the request - response = client.create_order_tracking_signal(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest, dict]): - The request object. Signals only can be created but not - updated. Businesses need to call this - API only when the order is completely - shipped. Creates new order signal. - parent (str): - Required. The account of the business - for which the order signal is created. - Format: accounts/{account} - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - order_tracking_signal_id (str): - Output only. The ID that uniquely - identifies this order tracking signal. - - This corresponds to the ``order_tracking_signal_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal: - Represents a business trade from - which signals are extracted, such as - shipping. - - """ - # Create or coerce a protobuf request object. - # - Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - flattened_params = [parent, order_tracking_signal_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): - request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if order_tracking_signal_id is not None: - request.order_tracking_signal_id = order_tracking_signal_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_order_tracking_signal] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "OrderTrackingSignalsServiceClient": - return self - - def __exit__(self, type, value, traceback): - """Releases underlying transport's resources. - - .. warning:: - ONLY use as a context manager if the transport is NOT shared - with other clients! Exiting the with block will CLOSE the transport - and may cause errors in other clients! - """ - self.transport.close() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - -__all__ = ( - "OrderTrackingSignalsServiceClient", -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst deleted file mode 100644 index 4c596b6640df..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/README.rst +++ /dev/null @@ -1,9 +0,0 @@ - -transport inheritance structure -_______________________________ - -`OrderTrackingSignalsServiceTransport` is the ABC for all transports. -- public child `OrderTrackingSignalsServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). -- public child `OrderTrackingSignalsServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). -- private child `_BaseOrderTrackingSignalsServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). -- public child `OrderTrackingSignalsServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py deleted file mode 100644 index a4268cd61d4e..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/base.py +++ /dev/null @@ -1,159 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union - -from google.shopping.merchant_ordertracking_v1beta import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore -import google.protobuf - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -class OrderTrackingSignalsServiceTransport(abc.ABC): - """Abstract transport class for OrderTrackingSignalsService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/content', - ) - - DEFAULT_HOST: str = 'merchantapi.googleapis.com' - - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'merchantapi.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - if not hasattr(self, "_ignore_credentials"): - self._ignore_credentials: bool = False - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None and not self._ignore_credentials: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - @property - def host(self): - return self._host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_order_tracking_signal: gapic_v1.method.wrap_method( - self.create_order_tracking_signal, - default_timeout=None, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - Union[ - order_tracking_signals.OrderTrackingSignal, - Awaitable[order_tracking_signals.OrderTrackingSignal] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'OrderTrackingSignalsServiceTransport', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py deleted file mode 100644 index a2c0f9e17da7..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc.py +++ /dev/null @@ -1,346 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import json -import logging as std_logging -import pickle -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.protobuf.json_format import MessageToJson -import google.protobuf.message - -import grpc # type: ignore -import proto # type: ignore - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - - -class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER - def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) - if logging_enabled: # pragma: NO COVER - request_metadata = client_call_details.metadata - if isinstance(request, proto.Message): - request_payload = type(request).to_json(request) - elif isinstance(request, google.protobuf.message.Message): - request_payload = MessageToJson(request) - else: - request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" - - request_metadata = { - key: value.decode("utf-8") if isinstance(value, bytes) else value - for key, value in request_metadata - } - grpc_request = { - "payload": request_payload, - "requestMethod": "grpc", - "metadata": dict(request_metadata), - } - _LOGGER.debug( - f"Sending request for {client_call_details.method}", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": str(client_call_details.method), - "request": grpc_request, - "metadata": grpc_request["metadata"], - }, - ) - response = continuation(client_call_details, request) - if logging_enabled: # pragma: NO COVER - response_metadata = response.trailing_metadata() - # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None - result = response.result() - if isinstance(result, proto.Message): - response_payload = type(result).to_json(result) - elif isinstance(result, google.protobuf.message.Message): - response_payload = MessageToJson(result) - else: - response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" - grpc_response = { - "payload": response_payload, - "metadata": metadata, - "status": "OK", - } - _LOGGER.debug( - f"Received response for {client_call_details.method}.", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": client_call_details.method, - "response": grpc_response, - "metadata": grpc_response["metadata"], - }, - ) - return response - - -class OrderTrackingSignalsServiceGrpcTransport(OrderTrackingSignalsServiceTransport): - """gRPC backend transport for OrderTrackingSignalsService. - - Service to serve order tracking signals public API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'merchantapi.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if a ``channel`` instance is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if a ``channel`` instance is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if a ``channel`` instance is provided. - channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if a ``channel`` instance is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if isinstance(channel, grpc.Channel): - # Ignore credentials if a channel was passed. - credentials = None - self._ignore_credentials = True - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - self._interceptor = _LoggingClientInterceptor() - self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) - - # Wrap messages. This must be done after self._logged_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - order_tracking_signals.OrderTrackingSignal]: - r"""Return a callable for the create order tracking signal method over gRPC. - - Creates new order tracking signal. - - Returns: - Callable[[~.CreateOrderTrackingSignalRequest], - ~.OrderTrackingSignal]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_order_tracking_signal' not in self._stubs: - self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( - '/google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService/CreateOrderTrackingSignal', - request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, - response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, - ) - return self._stubs['create_order_tracking_signal'] - - def close(self): - self._logged_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'OrderTrackingSignalsServiceGrpcTransport', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py deleted file mode 100644 index dddc753df6bb..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,367 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import inspect -import json -import pickle -import logging as std_logging -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.api_core import exceptions as core_exceptions -from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.protobuf.json_format import MessageToJson -import google.protobuf.message - -import grpc # type: ignore -import proto # type: ignore -from grpc.experimental import aio # type: ignore - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import OrderTrackingSignalsServiceGrpcTransport - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = std_logging.getLogger(__name__) - - -class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER - async def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) - if logging_enabled: # pragma: NO COVER - request_metadata = client_call_details.metadata - if isinstance(request, proto.Message): - request_payload = type(request).to_json(request) - elif isinstance(request, google.protobuf.message.Message): - request_payload = MessageToJson(request) - else: - request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" - - request_metadata = { - key: value.decode("utf-8") if isinstance(value, bytes) else value - for key, value in request_metadata - } - grpc_request = { - "payload": request_payload, - "requestMethod": "grpc", - "metadata": dict(request_metadata), - } - _LOGGER.debug( - f"Sending request for {client_call_details.method}", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": str(client_call_details.method), - "request": grpc_request, - "metadata": grpc_request["metadata"], - }, - ) - response = await continuation(client_call_details, request) - if logging_enabled: # pragma: NO COVER - response_metadata = await response.trailing_metadata() - # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None - result = await response - if isinstance(result, proto.Message): - response_payload = type(result).to_json(result) - elif isinstance(result, google.protobuf.message.Message): - response_payload = MessageToJson(result) - else: - response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" - grpc_response = { - "payload": response_payload, - "metadata": metadata, - "status": "OK", - } - _LOGGER.debug( - f"Received response to rpc {client_call_details.method}.", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": str(client_call_details.method), - "response": grpc_response, - "metadata": grpc_response["metadata"], - }, - ) - return response - - -class OrderTrackingSignalsServiceGrpcAsyncIOTransport(OrderTrackingSignalsServiceTransport): - """gRPC AsyncIO backend transport for OrderTrackingSignalsService. - - Service to serve order tracking signals public API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'merchantapi.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if a ``channel`` instance is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if a ``channel`` instance is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if a ``channel`` instance is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if isinstance(channel, aio.Channel): - # Ignore credentials if a channel was passed. - credentials = None - self._ignore_credentials = True - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - self._interceptor = _LoggingClientAIOInterceptor() - self._grpc_channel._unary_unary_interceptors.append(self._interceptor) - self._logged_channel = self._grpc_channel - self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters - # Wrap messages. This must be done after self._logged_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - Awaitable[order_tracking_signals.OrderTrackingSignal]]: - r"""Return a callable for the create order tracking signal method over gRPC. - - Creates new order tracking signal. - - Returns: - Callable[[~.CreateOrderTrackingSignalRequest], - Awaitable[~.OrderTrackingSignal]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'create_order_tracking_signal' not in self._stubs: - self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( - '/google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService/CreateOrderTrackingSignal', - request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, - response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, - ) - return self._stubs['create_order_tracking_signal'] - - def _prep_wrapped_messages(self, client_info): - """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" - self._wrapped_methods = { - self.create_order_tracking_signal: self._wrap_method( - self.create_order_tracking_signal, - default_timeout=None, - client_info=client_info, - ), - } - - def _wrap_method(self, func, *args, **kwargs): - if self._wrap_with_kind: # pragma: NO COVER - kwargs["kind"] = self.kind - return gapic_v1.method_async.wrap_method(func, *args, **kwargs) - - def close(self): - return self._logged_channel.close() - - @property - def kind(self) -> str: - return "grpc_asyncio" - - -__all__ = ( - 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py deleted file mode 100644 index bcca227d36f3..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest.py +++ /dev/null @@ -1,361 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import logging -import json # type: ignore - -from google.auth.transport.requests import AuthorizedSession # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import gapic_v1 -import google.protobuf - -from google.protobuf import json_format - -from requests import __version__ as requests_version -import dataclasses -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals - - -from .rest_base import _BaseOrderTrackingSignalsServiceRestTransport -from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -try: - from google.api_core import client_logging # type: ignore - CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER -except ImportError: # pragma: NO COVER - CLIENT_LOGGING_SUPPORTED = False - -_LOGGER = logging.getLogger(__name__) - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=f"requests@{requests_version}", -) - -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER - DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ - - -class OrderTrackingSignalsServiceRestInterceptor: - """Interceptor for OrderTrackingSignalsService. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the OrderTrackingSignalsServiceRestTransport. - - .. code-block:: python - class MyCustomOrderTrackingSignalsServiceInterceptor(OrderTrackingSignalsServiceRestInterceptor): - def pre_create_order_tracking_signal(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_order_tracking_signal(self, response): - logging.log(f"Received response: {response}") - return response - - transport = OrderTrackingSignalsServiceRestTransport(interceptor=MyCustomOrderTrackingSignalsServiceInterceptor()) - client = OrderTrackingSignalsServiceClient(transport=transport) - - - """ - def pre_create_order_tracking_signal(self, request: order_tracking_signals.CreateOrderTrackingSignalRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.CreateOrderTrackingSignalRequest, Sequence[Tuple[str, Union[str, bytes]]]]: - """Pre-rpc interceptor for create_order_tracking_signal - - Override in a subclass to manipulate the request or metadata - before they are sent to the OrderTrackingSignalsService server. - """ - return request, metadata - - def post_create_order_tracking_signal(self, response: order_tracking_signals.OrderTrackingSignal) -> order_tracking_signals.OrderTrackingSignal: - """Post-rpc interceptor for create_order_tracking_signal - - DEPRECATED. Please use the `post_create_order_tracking_signal_with_metadata` - interceptor instead. - - Override in a subclass to read or manipulate the response - after it is returned by the OrderTrackingSignalsService server but before - it is returned to user code. This `post_create_order_tracking_signal` interceptor runs - before the `post_create_order_tracking_signal_with_metadata` interceptor. - """ - return response - - def post_create_order_tracking_signal_with_metadata(self, response: order_tracking_signals.OrderTrackingSignal, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.OrderTrackingSignal, Sequence[Tuple[str, Union[str, bytes]]]]: - """Post-rpc interceptor for create_order_tracking_signal - - Override in a subclass to read or manipulate the response or metadata after it - is returned by the OrderTrackingSignalsService server but before it is returned to user code. - - We recommend only using this `post_create_order_tracking_signal_with_metadata` - interceptor in new development instead of the `post_create_order_tracking_signal` interceptor. - When both interceptors are used, this `post_create_order_tracking_signal_with_metadata` interceptor runs after the - `post_create_order_tracking_signal` interceptor. The (possibly modified) response returned by - `post_create_order_tracking_signal` will be passed to - `post_create_order_tracking_signal_with_metadata`. - """ - return response, metadata - - -@dataclasses.dataclass -class OrderTrackingSignalsServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: OrderTrackingSignalsServiceRestInterceptor - - -class OrderTrackingSignalsServiceRestTransport(_BaseOrderTrackingSignalsServiceRestTransport): - """REST backend synchronous transport for OrderTrackingSignalsService. - - Service to serve order tracking signals public API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends JSON representations of protocol buffers over HTTP/1.1 - """ - - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[Callable[[ - ], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - interceptor: Optional[OrderTrackingSignalsServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'merchantapi.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - url_scheme=url_scheme, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or OrderTrackingSignalsServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _CreateOrderTrackingSignal(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal, OrderTrackingSignalsServiceRestStub): - def __hash__(self): - return hash("OrderTrackingSignalsServiceRestTransport.CreateOrderTrackingSignal") - - @staticmethod - def _get_response( - host, - metadata, - query_params, - session, - timeout, - transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(session, method)( - "{host}{uri}".format(host=host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - return response - - def __call__(self, - request: order_tracking_signals.CreateOrderTrackingSignalRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> order_tracking_signals.OrderTrackingSignal: - r"""Call the create order tracking - signal method over HTTP. - - Args: - request (~.order_tracking_signals.CreateOrderTrackingSignalRequest): - The request object. Signals only can be created but not - updated. Businesses need to call this - API only when the order is completely - shipped. Creates new order signal. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.order_tracking_signals.OrderTrackingSignal: - Represents a business trade from - which signals are extracted, such as - shipping. - - """ - - http_options = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_http_options() - - request, metadata = self._interceptor.pre_create_order_tracking_signal(request, metadata) - transcoded_request = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_transcoded_request(http_options, request) - - body = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_request_body_json(transcoded_request) - - # Jsonify the query params - query_params = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] - try: - request_payload = type(request).to_json(request) - except: - request_payload = None - http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), - } - _LOGGER.debug( - f"Sending request for google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient.CreateOrderTrackingSignal", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": "CreateOrderTrackingSignal", - "httpRequest": http_request, - "metadata": http_request["headers"], - }, - ) - - # Send the request - response = OrderTrackingSignalsServiceRestTransport._CreateOrderTrackingSignal._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, body) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = order_tracking_signals.OrderTrackingSignal() - pb_resp = order_tracking_signals.OrderTrackingSignal.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - - resp = self._interceptor.post_create_order_tracking_signal(resp) - response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_order_tracking_signal_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - try: - response_payload = order_tracking_signals.OrderTrackingSignal.to_json(response) - except: - response_payload = None - http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, - } - _LOGGER.debug( - "Received response for google.shopping.merchant.ordertracking_v1beta.OrderTrackingSignalsServiceClient.create_order_tracking_signal", - extra = { - "serviceName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "rpcName": "CreateOrderTrackingSignal", - "metadata": http_response["headers"], - "httpResponse": http_response, - }, - ) - return resp - - @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - order_tracking_signals.OrderTrackingSignal]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._CreateOrderTrackingSignal(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'OrderTrackingSignalsServiceRestTransport', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py deleted file mode 100644 index b1321ddf046b..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/rest_base.py +++ /dev/null @@ -1,138 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import json # type: ignore -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO - -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union - - -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals - - -class _BaseOrderTrackingSignalsServiceRestTransport(OrderTrackingSignalsServiceTransport): - """Base REST backend transport for OrderTrackingSignalsService. - - Note: This class is not meant to be used directly. Use its sync and - async sub-classes instead. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends JSON representations of protocol buffers over HTTP/1.1 - """ - - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[Any] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - Args: - host (Optional[str]): - The hostname to connect to (default: 'merchantapi.googleapis.com'). - credentials (Optional[Any]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - - class _BaseCreateOrderTrackingSignal: - def __hash__(self): # pragma: NO COVER - return NotImplementedError("__hash__ must be implemented.") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - @staticmethod - def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/ordertracking/v1beta/{parent=accounts/*}/ordertrackingsignals', - 'body': 'order_tracking_signal', - }, - ] - return http_options - - @staticmethod - def _get_transcoded_request(http_options, request): - pb_request = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - return transcoded_request - - @staticmethod - def _get_request_body_json(transcoded_request): - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - return body - @staticmethod - def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - return query_params - - -__all__=( - '_BaseOrderTrackingSignalsServiceRestTransport', -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py deleted file mode 100644 index 678343f40cd7..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/order_tracking_signals.py +++ /dev/null @@ -1,375 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.shopping.type.types import types -from google.type import datetime_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.shopping.merchant.ordertracking.v1beta', - manifest={ - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', - }, -) - - -class CreateOrderTrackingSignalRequest(proto.Message): - r"""Signals only can be created but not updated. - Businesses need to call this API only when the order is - completely shipped. Creates new order signal. - - Attributes: - parent (str): - Required. The account of the business for - which the order signal is created. Format: - accounts/{account} - order_tracking_signal_id (str): - Output only. The ID that uniquely identifies - this order tracking signal. - order_tracking_signal (google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal): - Required. The order signal to be created. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - order_tracking_signal_id: str = proto.Field( - proto.STRING, - number=2, - ) - order_tracking_signal: 'OrderTrackingSignal' = proto.Field( - proto.MESSAGE, - number=3, - message='OrderTrackingSignal', - ) - - -class OrderTrackingSignal(proto.Message): - r"""Represents a business trade from which signals are extracted, - such as shipping. - - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - order_tracking_signal_id (int): - Output only. The ID that uniquely identifies - this order tracking signal. - merchant_id (int): - Optional. The Google Merchant Center ID of this order - tracking signal. This value is optional. If left unset, the - caller's Merchant Center ID is used. You must request access - in order to provide data on behalf of another business. For - more information, see `Submitting Order Tracking - Signals `__. - order_created_time (google.type.datetime_pb2.DateTime): - Required. The time when the order was created - on the businesses side. Include the year and - timezone string, if available. - order_id (str): - Required. The ID of the order on the - businesses side. This field will be hashed in - returned OrderTrackingSignal creation response. - shipping_info (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShippingInfo]): - Required. The shipping information for the - order. - line_items (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.LineItemDetails]): - Required. Information about line items in the - order. - shipment_line_item_mapping (MutableSequence[google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShipmentLineItemMapping]): - Optional. The mapping of the line items to - the shipment information. - customer_shipping_fee (google.shopping.type.types.Price): - Optional. The shipping fee of the order; - this value should be set to zero in the case of - free shipping. - - This field is a member of `oneof`_ ``_customer_shipping_fee``. - delivery_postal_code (str): - Optional. The delivery postal code, as a - continuous string without spaces or dashes, for - example "95016". This field will be anonymized - in returned OrderTrackingSignal creation - response. - delivery_region_code (str): - Optional. The [CLDR territory code] - (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) - for the shipping destination. - """ - - class ShippingInfo(proto.Message): - r"""The shipping information for the order. - - Attributes: - shipment_id (str): - Required. The shipment ID. This field will be - hashed in returned OrderTrackingSignal creation - response. - tracking_id (str): - Optional. The tracking ID of the shipment. This field is - required if one of the following fields is absent: - earliest_delivery_promise_time, - latest_delivery_promise_time, and actual_delivery_time. - carrier (str): - Optional. The name of the shipping carrier for the delivery. - This field is required if one of the following fields is - absent: earliest_delivery_promise_time, - latest_delivery_promise_time, and actual_delivery_time. - carrier_service (str): - Optional. The service type for fulfillment, such as GROUND, - FIRST_CLASS, etc. - shipped_time (google.type.datetime_pb2.DateTime): - Optional. The time when the shipment was - shipped. Include the year and timezone string, - if available. - earliest_delivery_promise_time (google.type.datetime_pb2.DateTime): - Optional. The earliest delivery promised time. Include the - year and timezone string, if available. This field is - required, if one of the following fields is absent: - tracking_id or carrier_name. - latest_delivery_promise_time (google.type.datetime_pb2.DateTime): - Optional. The latest delivery promised time. Include the - year and timezone string, if available. This field is - required, if one of the following fields is absent: - tracking_id or carrier_name. - actual_delivery_time (google.type.datetime_pb2.DateTime): - Optional. The time when the shipment was actually delivered. - Include the year and timezone string, if available. This - field is required, if one of the following fields is absent: - tracking_id or carrier_name. - shipping_status (google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal.ShippingInfo.ShippingState): - Required. The status of the shipment. - origin_postal_code (str): - Required. The origin postal code, as a - continuous string without spaces or dashes, for - example "95016". This field will be anonymized - in returned OrderTrackingSignal creation - response. - origin_region_code (str): - Required. The [CLDR territory code] - (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) - for the shipping origin. - """ - class ShippingState(proto.Enum): - r"""The current status of the shipments. - - Values: - SHIPPING_STATE_UNSPECIFIED (0): - The shipping status is not known to business. - SHIPPED (1): - All items are shipped. - DELIVERED (2): - The shipment is already delivered. - """ - SHIPPING_STATE_UNSPECIFIED = 0 - SHIPPED = 1 - DELIVERED = 2 - - shipment_id: str = proto.Field( - proto.STRING, - number=1, - ) - tracking_id: str = proto.Field( - proto.STRING, - number=2, - ) - carrier: str = proto.Field( - proto.STRING, - number=3, - ) - carrier_service: str = proto.Field( - proto.STRING, - number=4, - ) - shipped_time: datetime_pb2.DateTime = proto.Field( - proto.MESSAGE, - number=5, - message=datetime_pb2.DateTime, - ) - earliest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( - proto.MESSAGE, - number=6, - message=datetime_pb2.DateTime, - ) - latest_delivery_promise_time: datetime_pb2.DateTime = proto.Field( - proto.MESSAGE, - number=7, - message=datetime_pb2.DateTime, - ) - actual_delivery_time: datetime_pb2.DateTime = proto.Field( - proto.MESSAGE, - number=8, - message=datetime_pb2.DateTime, - ) - shipping_status: 'OrderTrackingSignal.ShippingInfo.ShippingState' = proto.Field( - proto.ENUM, - number=9, - enum='OrderTrackingSignal.ShippingInfo.ShippingState', - ) - origin_postal_code: str = proto.Field( - proto.STRING, - number=10, - ) - origin_region_code: str = proto.Field( - proto.STRING, - number=11, - ) - - class LineItemDetails(proto.Message): - r"""The line items of the order. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - line_item_id (str): - Required. The ID for this line item. - product_id (str): - Required. The Content API REST ID of the - product, in the form - channel:contentLanguage:targetCountry:offerId. - gtin (str): - Optional. The Global Trade Item Number. - mpn (str): - Optional. The manufacturer part number. - product_title (str): - Optional. Plain text title of this product. - - This field is a member of `oneof`_ ``_product_title``. - brand (str): - Optional. Brand of the product. - - This field is a member of `oneof`_ ``_brand``. - quantity (int): - Required. The quantity of the line item in - the order. - """ - - line_item_id: str = proto.Field( - proto.STRING, - number=1, - ) - product_id: str = proto.Field( - proto.STRING, - number=2, - ) - gtin: str = proto.Field( - proto.STRING, - number=3, - ) - mpn: str = proto.Field( - proto.STRING, - number=4, - ) - product_title: str = proto.Field( - proto.STRING, - number=5, - optional=True, - ) - brand: str = proto.Field( - proto.STRING, - number=6, - optional=True, - ) - quantity: int = proto.Field( - proto.INT64, - number=7, - ) - - class ShipmentLineItemMapping(proto.Message): - r"""Represents how many items are in the shipment for the given - shipment_id and line_item_id. - - Attributes: - shipment_id (str): - Required. The shipment ID. This field will be - hashed in returned OrderTrackingSignal creation - response. - line_item_id (str): - Required. The line item ID. - quantity (int): - Required. The line item quantity in the - shipment. - """ - - shipment_id: str = proto.Field( - proto.STRING, - number=1, - ) - line_item_id: str = proto.Field( - proto.STRING, - number=2, - ) - quantity: int = proto.Field( - proto.INT64, - number=3, - ) - - order_tracking_signal_id: int = proto.Field( - proto.INT64, - number=11, - ) - merchant_id: int = proto.Field( - proto.INT64, - number=12, - ) - order_created_time: datetime_pb2.DateTime = proto.Field( - proto.MESSAGE, - number=1, - message=datetime_pb2.DateTime, - ) - order_id: str = proto.Field( - proto.STRING, - number=2, - ) - shipping_info: MutableSequence[ShippingInfo] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message=ShippingInfo, - ) - line_items: MutableSequence[LineItemDetails] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message=LineItemDetails, - ) - shipment_line_item_mapping: MutableSequence[ShipmentLineItemMapping] = proto.RepeatedField( - proto.MESSAGE, - number=5, - message=ShipmentLineItemMapping, - ) - customer_shipping_fee: types.Price = proto.Field( - proto.MESSAGE, - number=6, - optional=True, - message=types.Price, - ) - delivery_postal_code: str = proto.Field( - proto.STRING, - number=9, - ) - delivery_region_code: str = proto.Field( - proto.STRING, - number=10, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py deleted file mode 100644 index 5a16b31cc051..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/noxfile.py +++ /dev/null @@ -1,591 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import os -import pathlib -import re -import shutil - -from typing import Dict, List -import warnings - -import nox - -BLACK_VERSION = "black[jupyter]==23.7.0" -ISORT_VERSION = "isort==5.11.0" - -LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", - "3.12", - "3.13", -] - -DEFAULT_PYTHON_VERSION = ALL_PYTHON[-1] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = "google-shopping-merchant-ordertracking" - -UNIT_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "asyncmock", - "pytest", - "pytest-cov", - "pytest-asyncio", -] -UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = [] -UNIT_TEST_DEPENDENCIES: List[str] = [] -UNIT_TEST_EXTRAS: List[str] = [] -UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"] -SYSTEM_TEST_STANDARD_DEPENDENCIES = [ - "mock", - "pytest", - "google-cloud-testutils", -] -SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_DEPENDENCIES: List[str] = [] -SYSTEM_TEST_EXTRAS: List[str] = [] -SYSTEM_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {} - -nox.options.sessions = [ - "unit", - "system", - "cover", - "lint", - "lint_setup_py", - "blacken", - "docs", -] - -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - "mypy", - "types-requests", - "types-protobuf", - ) - session.install(".") - session.run( - "mypy", - "-p", - "google", - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install("google-cloud-testutils") - session.install(".") - - session.run( - "lower-bound-checker", - "update", - "--package-name", - PACKAGE_NAME, - "--constraints-file", - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install("google-cloud-testutils") - session.install(".") - - session.run( - "lower-bound-checker", - "check", - "--package-name", - PACKAGE_NAME, - "--constraints-file", - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *LINT_PATHS, - ) - - session.run("flake8", "google", "tests") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def format(session): - """ - Run isort to sort imports. Then run black - to format code to uniform standard. - """ - session.install(BLACK_VERSION, ISORT_VERSION) - # Use the --fss option to sort imports using strict alphabetical order. - # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections - session.run( - "isort", - "--fss", - *LINT_PATHS, - ) - session.run( - "black", - *LINT_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("setuptools", "docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") - - -def install_unittest_dependencies(session, *constraints): - standard_deps = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_DEPENDENCIES - session.install(*standard_deps, *constraints) - - if UNIT_TEST_EXTERNAL_DEPENDENCIES: - warnings.warn( - "'unit_test_external_dependencies' is deprecated. Instead, please " - "use 'unit_test_dependencies' or 'unit_test_local_dependencies'.", - DeprecationWarning, - ) - session.install(*UNIT_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_LOCAL_DEPENDENCIES: - session.install(*UNIT_TEST_LOCAL_DEPENDENCIES, *constraints) - - if UNIT_TEST_EXTRAS_BY_PYTHON: - extras = UNIT_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif UNIT_TEST_EXTRAS: - extras = UNIT_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=ALL_PYTHON) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def unit(session, protobuf_implementation): - # Install all test dependencies, then install this package in-place. - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - install_unittest_dependencies(session, "-c", constraints_path) - - # TODO(https://github.com/googleapis/synthtool/issues/1976): - # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. - # The 'cpp' implementation requires Protobuf<4. - if protobuf_implementation == "cpp": - session.install("protobuf<4") - - # Run py.test against the unit tests. - session.run( - "py.test", - "--quiet", - f"--junitxml=unit_{session.python}_sponge_log.xml", - "--cov=google", - "--cov=tests/unit", - "--cov-append", - "--cov-config=.coveragerc", - "--cov-report=", - "--cov-fail-under=0", - os.path.join("tests", "unit"), - *session.posargs, - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -def install_systemtest_dependencies(session, *constraints): - session.install("--pre", "grpcio") - - session.install(*SYSTEM_TEST_STANDARD_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTERNAL_DEPENDENCIES: - session.install(*SYSTEM_TEST_EXTERNAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_LOCAL_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_LOCAL_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_DEPENDENCIES: - session.install("-e", *SYSTEM_TEST_DEPENDENCIES, *constraints) - - if SYSTEM_TEST_EXTRAS_BY_PYTHON: - extras = SYSTEM_TEST_EXTRAS_BY_PYTHON.get(session.python, []) - elif SYSTEM_TEST_EXTRAS: - extras = SYSTEM_TEST_EXTRAS - else: - extras = [] - - if extras: - session.install("-e", f".[{','.join(extras)}]", *constraints) - else: - session.install("-e", ".", *constraints) - - -@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) -def system(session): - """Run the system test suite.""" - constraints_path = str( - CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" - ) - system_test_path = os.path.join("tests", "system.py") - system_test_folder_path = os.path.join("tests", "system") - - # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. - if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": - session.skip("RUN_SYSTEM_TESTS is set to false, skipping") - # Install pyopenssl for mTLS testing. - if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": - session.install("pyopenssl") - - system_test_exists = os.path.exists(system_test_path) - system_test_folder_exists = os.path.exists(system_test_folder_path) - # Sanity check: only run tests if found. - if not system_test_exists and not system_test_folder_exists: - session.skip("System tests were not found") - - install_systemtest_dependencies(session, "-c", constraints_path) - - # Run py.test against the system tests. - if system_test_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_path, - *session.posargs, - ) - if system_test_folder_exists: - session.run( - "py.test", - "--quiet", - f"--junitxml=system_{session.python}_sponge_log.xml", - system_test_folder_path, - *session.posargs, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python="3.10") -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "sphinx==4.5.0", - "alabaster", - "recommonmark", - ) - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python="3.10") -def docfx(session): - """Build the docfx yaml files for this library.""" - - session.install("-e", ".") - session.install( - # We need to pin to specific versions of the `sphinxcontrib-*` packages - # which still support sphinx 4.x. - # See https://github.com/googleapis/sphinx-docfx-yaml/issues/344 - # and https://github.com/googleapis/sphinx-docfx-yaml/issues/345. - "sphinxcontrib-applehelp==1.0.4", - "sphinxcontrib-devhelp==1.0.2", - "sphinxcontrib-htmlhelp==2.0.1", - "sphinxcontrib-qthelp==1.0.3", - "sphinxcontrib-serializinghtml==1.1.5", - "gcp-sphinx-docfx-yaml", - "alabaster", - "recommonmark", - ) - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-T", # show full traceback on exception - "-N", # no colors - "-D", - ( - "extensions=sphinx.ext.autodoc," - "sphinx.ext.autosummary," - "docfx_yaml.extension," - "sphinx.ext.intersphinx," - "sphinx.ext.coverage," - "sphinx.ext.napoleon," - "sphinx.ext.todo," - "sphinx.ext.viewcode," - "recommonmark" - ), - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb", "cpp"], -) -def prerelease_deps(session, protobuf_implementation): - """ - Run all tests with pre-release versions of dependencies installed - rather than the standard non pre-release versions. - Pre-release versions can be installed using - `pip install --pre `. - """ - - if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"): - session.skip("cpp implementation is not supported in python 3.11+") - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # Note: If a dependency is added to the `prerel_deps` list, - # the `core_dependencies_from_source` list in the `core_deps_from_source` - # nox session should also be updated. - prerel_deps = [ - "googleapis-common-protos", - "google-api-core", - "google-auth", - "grpc-google-iam-v1", - "grpcio", - "grpcio-status", - "protobuf", - "proto-plus", - ] - - for dep in prerel_deps: - session.install("--pre", "--no-deps", "--ignore-installed", dep) - # TODO(https://github.com/grpc/grpc/issues/38965): Add `grpcio-status`` - # to the dictionary below once this bug is fixed. - # TODO(https://github.com/googleapis/google-cloud-python/issues/13643): Add - # `googleapis-common-protos` and `grpc-google-iam-v1` to the dictionary below - # once this bug is fixed. - package_namespaces = { - "google-api-core": "google.api_core", - "google-auth": "google.auth", - "grpcio": "grpc", - "protobuf": "google.protobuf", - "proto-plus": "proto", - } - - version_namespace = package_namespaces.get(dep) - - print(f"Installed {dep}") - if version_namespace: - session.run( - "python", - "-c", - f"import {version_namespace}; print({version_namespace}.__version__)", - ) - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -@nox.parametrize( - "protobuf_implementation", - ["python", "upb"], -) -def core_deps_from_source(session, protobuf_implementation): - """Run all tests with core dependencies installed from source - rather than pulling the dependencies from PyPI. - """ - - # Install all dependencies - session.install("-e", ".") - - # Install dependencies for the unit test environment - unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES - session.install(*unit_deps_all) - - # Install dependencies for the system test environment - system_deps_all = ( - SYSTEM_TEST_STANDARD_DEPENDENCIES - + SYSTEM_TEST_EXTERNAL_DEPENDENCIES - + SYSTEM_TEST_EXTRAS - ) - session.install(*system_deps_all) - - # Because we test minimum dependency versions on the minimum Python - # version, the first version we test with in the unit tests sessions has a - # constraints file containing all dependencies and extras. - with open( - CURRENT_DIRECTORY / "testing" / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - # Install dependencies specified in `testing/constraints-X.txt`. - session.install(*constraints_deps) - - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2358): `grpcio` and - # `grpcio-status` should be added to the list below so that they are installed from source, - # rather than PyPI. - # TODO(https://github.com/googleapis/gapic-generator-python/issues/2357): `protobuf` should be - # added to the list below so that it is installed from source, rather than PyPI - # Note: If a dependency is added to the `core_dependencies_from_source` list, - # the `prerel_deps` list in the `prerelease_deps` nox session should also be updated. - core_dependencies_from_source = [ - "googleapis-common-protos @ git+https://github.com/googleapis/google-cloud-python#egg=googleapis-common-protos&subdirectory=packages/googleapis-common-protos", - "google-api-core @ git+https://github.com/googleapis/python-api-core.git", - "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git", - "grpc-google-iam-v1 @ git+https://github.com/googleapis/google-cloud-python#egg=grpc-google-iam-v1&subdirectory=packages/grpc-google-iam-v1", - "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git", - ] - - for dep in core_dependencies_from_source: - session.install(dep, "--no-deps", "--ignore-installed") - print(f"Installed {dep}") - - session.run( - "py.test", - "tests/unit", - env={ - "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, - }, - ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py deleted file mode 100644 index b9bc40ca3b27..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py +++ /dev/null @@ -1,63 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for CreateOrderTrackingSignal -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-shopping-merchant-ordertracking - - -# [START merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.shopping import merchant_ordertracking_v1beta - - -async def sample_create_order_tracking_signal(): - # Create a client - client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient() - - # Initialize request argument(s) - order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() - order_tracking_signal.order_id = "order_id_value" - order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" - order_tracking_signal.shipping_info.shipping_status = "DELIVERED" - order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" - order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" - order_tracking_signal.line_items.line_item_id = "line_item_id_value" - order_tracking_signal.line_items.product_id = "product_id_value" - order_tracking_signal.line_items.quantity = 895 - - request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( - parent="parent_value", - order_tracking_signal=order_tracking_signal, - ) - - # Make the request - response = await client.create_order_tracking_signal(request=request) - - # Handle the response - print(response) - -# [END merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py deleted file mode 100644 index a4cab8b8aa25..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py +++ /dev/null @@ -1,63 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for CreateOrderTrackingSignal -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-shopping-merchant-ordertracking - - -# [START merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.shopping import merchant_ordertracking_v1beta - - -def sample_create_order_tracking_signal(): - # Create a client - client = merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient() - - # Initialize request argument(s) - order_tracking_signal = merchant_ordertracking_v1beta.OrderTrackingSignal() - order_tracking_signal.order_id = "order_id_value" - order_tracking_signal.shipping_info.shipment_id = "shipment_id_value" - order_tracking_signal.shipping_info.shipping_status = "DELIVERED" - order_tracking_signal.shipping_info.origin_postal_code = "origin_postal_code_value" - order_tracking_signal.shipping_info.origin_region_code = "origin_region_code_value" - order_tracking_signal.line_items.line_item_id = "line_item_id_value" - order_tracking_signal.line_items.product_id = "product_id_value" - order_tracking_signal.line_items.quantity = 895 - - request = merchant_ordertracking_v1beta.CreateOrderTrackingSignalRequest( - parent="parent_value", - order_tracking_signal=order_tracking_signal, - ) - - # Make the request - response = client.create_order_tracking_signal(request=request) - - # Handle the response - print(response) - -# [END merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync] diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json deleted file mode 100644 index a8d7d063cb20..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1beta.json +++ /dev/null @@ -1,184 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.shopping.merchant.ordertracking.v1beta", - "version": "v1beta" - } - ], - "language": "PYTHON", - "name": "google-shopping-merchant-ordertracking", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient", - "shortName": "OrderTrackingSignalsServiceAsyncClient" - }, - "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceAsyncClient.create_order_tracking_signal", - "method": { - "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService.CreateOrderTrackingSignal", - "service": { - "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "shortName": "OrderTrackingSignalsService" - }, - "shortName": "CreateOrderTrackingSignal" - }, - "parameters": [ - { - "name": "request", - "type": "google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "order_tracking_signal_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal", - "shortName": "create_order_tracking_signal" - }, - "description": "Sample for CreateOrderTrackingSignal", - "file": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_async", - "segments": [ - { - "end": 62, - "start": 27, - "type": "FULL" - }, - { - "end": 62, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 59, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 63, - "start": 60, - "type": "RESPONSE_HANDLING" - } - ], - "title": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient", - "shortName": "OrderTrackingSignalsServiceClient" - }, - "fullName": "google.shopping.merchant_ordertracking_v1beta.OrderTrackingSignalsServiceClient.create_order_tracking_signal", - "method": { - "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService.CreateOrderTrackingSignal", - "service": { - "fullName": "google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignalsService", - "shortName": "OrderTrackingSignalsService" - }, - "shortName": "CreateOrderTrackingSignal" - }, - "parameters": [ - { - "name": "request", - "type": "google.shopping.merchant_ordertracking_v1beta.types.CreateOrderTrackingSignalRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "order_tracking_signal_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, Union[str, bytes]]]" - } - ], - "resultType": "google.shopping.merchant_ordertracking_v1beta.types.OrderTrackingSignal", - "shortName": "create_order_tracking_signal" - }, - "description": "Sample for CreateOrderTrackingSignal", - "file": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "merchantapi_v1beta_generated_OrderTrackingSignalsService_CreateOrderTrackingSignal_sync", - "segments": [ - { - "end": 62, - "start": 27, - "type": "FULL" - }, - { - "end": 62, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 56, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 59, - "start": 57, - "type": "REQUEST_EXECUTION" - }, - { - "end": 63, - "start": 60, - "type": "RESPONSE_HANDLING" - } - ], - "title": "merchantapi_v1beta_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py" - } - ] -} diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py deleted file mode 100644 index 10ea1b8455fe..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/scripts/fixup_merchant_ordertracking_v1beta_keywords.py +++ /dev/null @@ -1,176 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class merchant_ordertrackingCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_order_tracking_signal': ('parent', 'order_tracking_signal', 'order_tracking_signal_id', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: a.keyword.value not in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=merchant_ordertrackingCallTransformer(), -): - """Duplicate the input dir to the output dir, fixing file method calls. - - Preconditions: - * in_dir is a real directory - * out_dir is a real, empty directory - """ - pyfile_gen = ( - pathlib.Path(os.path.join(root, f)) - for root, _, files in os.walk(in_dir) - for f in files if os.path.splitext(f)[1] == ".py" - ) - - for fpath in pyfile_gen: - with open(fpath, 'r') as f: - src = f.read() - - # Parse the code and insert method call fixes. - tree = cst.parse_module(src) - updated = tree.visit(transformer) - - # Create the path and directory structure for the new file. - updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) - updated_path.parent.mkdir(parents=True, exist_ok=True) - - # Generate the updated source file at the corresponding path. - with open(updated_path, 'w') as f: - f.write(updated.code) - - -if __name__ == '__main__': - parser = argparse.ArgumentParser( - description="""Fix up source that uses the merchant_ordertracking client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py deleted file mode 100644 index 44b1307169b0..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/setup.py +++ /dev/null @@ -1,99 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import io -import os -import re - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-shopping-merchant-ordertracking' - - -description = "Google Shopping Merchant Ordertracking API client library" - -version = None - -with open(os.path.join(package_root, 'google/shopping/merchant_ordertracking/gapic_version.py')) as fp: - version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) - assert (len(version_candidates) == 1) - version = version_candidates[0] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - # Exclude incompatible versions of `google-auth` - # See https://github.com/googleapis/google-cloud-python/issues/12364 - "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0", - "proto-plus >= 1.22.3, <2.0.0", - "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'", - "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", - "google-shopping-type >= 0.1.6, <1.0.0", -] -extras = { -} -url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-shopping-merchant-ordertracking" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.find_namespace_packages() - if package.startswith("google") -] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Programming Language :: Python :: 3.13", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - install_requires=dependencies, - extras_require=extras, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.10.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.11.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.12.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt deleted file mode 100644 index 0112695e5bbb..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.13.txt +++ /dev/null @@ -1,12 +0,0 @@ -# We use the constraints file for the latest Python version -# (currently this file) to check that the latest -# major versions of dependencies are supported in setup.py. -# List all library dependencies and extras in this file. -# Require the latest major version be installed for each dependency. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", -# Then this file should have google-cloud-foo>=1 -google-api-core>=2 -google-auth>=2 -proto-plus>=1 -protobuf>=6 -google-shopping-type>=0 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt deleted file mode 100644 index 2af887ec8ba0..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.7.txt +++ /dev/null @@ -1,11 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.1 -google-auth==2.14.1 -proto-plus==1.22.3 -protobuf==3.20.2 -google-shopping-type==0.1.6 diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.8.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt deleted file mode 100644 index 4cae520d02b2..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/testing/constraints-3.9.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-shopping-type diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py deleted file mode 100644 index 191773d5572d..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py b/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py deleted file mode 100644 index 2b93e3431d76..000000000000 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/tests/unit/gapic/merchant_ordertracking_v1beta/test_order_tracking_signals_service.py +++ /dev/null @@ -1,2243 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2025 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. -# -import os -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable, AsyncIterable -from google.protobuf import json_format -import json -import math -import pytest -from google.api_core import api_core_version -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -try: - from google.auth.aio import credentials as ga_credentials_async - HAS_GOOGLE_AUTH_AIO = True -except ImportError: # pragma: NO COVER - HAS_GOOGLE_AUTH_AIO = False - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.oauth2 import service_account -from google.protobuf import duration_pb2 # type: ignore -from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient -from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import OrderTrackingSignalsServiceClient -from google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service import transports -from google.shopping.merchant_ordertracking_v1beta.types import order_tracking_signals -from google.shopping.type.types import types -from google.type import datetime_pb2 # type: ignore -import google.auth - - - -CRED_INFO_JSON = { - "credential_source": "/path/to/file", - "credential_type": "service account credentials", - "principal": "service-account@example.com", -} -CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) - - -async def mock_async_gen(data, chunk_size=1): - for i in range(0, len(data)): # pragma: NO COVER - chunk = data[i : i + chunk_size] - yield chunk.encode("utf-8") - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - -# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. -# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. -def async_anonymous_credentials(): - if HAS_GOOGLE_AUTH_AIO: - return ga_credentials_async.AnonymousCredentials() - return ga_credentials.AnonymousCredentials() - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - -# If default endpoint template is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint template so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint_template(client): - return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(None) is None - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - -def test__read_environment_variables(): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (True, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - OrderTrackingSignalsServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "never", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "always", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - OrderTrackingSignalsServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", "foo.com") - -def test__get_client_cert_source(): - mock_provided_cert_source = mock.Mock() - mock_default_cert_source = mock.Mock() - - assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, False) is None - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source - - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): - assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, True) is mock_default_cert_source - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source - -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) -def test__get_api_endpoint(): - api_override = "foo.com" - mock_client_cert_source = mock.Mock() - default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - assert OrderTrackingSignalsServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint - - with pytest.raises(MutualTLSChannelError) as excinfo: - OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") - assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." - - -def test__get_universe_domain(): - client_universe_domain = "foo.com" - universe_domain_env = "bar.com" - - assert OrderTrackingSignalsServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain - assert OrderTrackingSignalsServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env - assert OrderTrackingSignalsServiceClient._get_universe_domain(None, None) == OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - - with pytest.raises(ValueError) as excinfo: - OrderTrackingSignalsServiceClient._get_universe_domain("", None) - assert str(excinfo.value) == "Universe Domain cannot be an empty string." - -@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ - (401, CRED_INFO_JSON, True), - (403, CRED_INFO_JSON, True), - (404, CRED_INFO_JSON, True), - (500, CRED_INFO_JSON, False), - (401, None, False), - (403, None, False), - (404, None, False), - (500, None, False) -]) -def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): - cred = mock.Mock(["get_cred_info"]) - cred.get_cred_info = mock.Mock(return_value=cred_info_json) - client = OrderTrackingSignalsServiceClient(credentials=cred) - client._transport._credentials = cred - - error = core_exceptions.GoogleAPICallError("message", details=["foo"]) - error.code = error_code - - client._add_cred_info_for_auth_errors(error) - if show_cred_info: - assert error.details == ["foo", CRED_INFO_STRING] - else: - assert error.details == ["foo"] - -@pytest.mark.parametrize("error_code", [401,403,404,500]) -def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): - cred = mock.Mock([]) - assert not hasattr(cred, "get_cred_info") - client = OrderTrackingSignalsServiceClient(credentials=cred) - client._transport._credentials = cred - - error = core_exceptions.GoogleAPICallError("message", details=[]) - error.code = error_code - - client._add_cred_info_for_auth_errors(error) - assert error.details == [] - -@pytest.mark.parametrize("client_class,transport_name", [ - (OrderTrackingSignalsServiceClient, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, "rest"), -]) -def test_order_tracking_signals_service_client_from_service_account_info(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://merchantapi.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -def test_order_tracking_signals_service_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class,transport_name", [ - (OrderTrackingSignalsServiceClient, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, "rest"), -]) -def test_order_tracking_signals_service_client_from_service_account_file(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://merchantapi.googleapis.com' - ) - - -def test_order_tracking_signals_service_client_get_transport_class(): - transport = OrderTrackingSignalsServiceClient.get_transport_class() - available_transports = [ - transports.OrderTrackingSignalsServiceGrpcTransport, - transports.OrderTrackingSignalsServiceRestTransport, - ] - assert transport in available_transports - - transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc") - assert transport == transports.OrderTrackingSignalsServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) -def test_order_tracking_signals_service_client_client_options(client_class, transport_class, transport_name): - # Check that if channel is provided we won't create a new one. - with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "true"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "false"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "true"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_order_tracking_signals_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class", [ - OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceAsyncClient)) -def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - -@pytest.mark.parametrize("client_class", [ - OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) -def test_order_tracking_signals_service_client_client_api_endpoint(client_class): - mock_client_cert_source = client_cert_source_callback - api_override = "foo.com" - default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", - # use ClientOptions.api_endpoint as the api endpoint regardless. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == api_override - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", - # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - - # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), - # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, - # and ClientOptions.universe_domain="bar.com", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. - options = client_options.ClientOptions() - universe_exists = hasattr(options, "universe_domain") - if universe_exists: - options = client_options.ClientOptions(universe_domain=mock_universe) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - else: - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) - assert client.universe_domain == (mock_universe if universe_exists else default_universe) - - # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - options = client_options.ClientOptions() - if hasattr(options, "universe_domain"): - delattr(options, "universe_domain") - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -def test_order_tracking_signals_service_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", None), -]) -def test_order_tracking_signals_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -def test_order_tracking_signals_service_client_client_options_from_dict(): - with mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = OrderTrackingSignalsServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_order_tracking_signals_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "merchantapi.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), - scopes=None, - default_host="merchantapi.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - order_tracking_signals.CreateOrderTrackingSignalRequest, - dict, -]) -def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - ) - response = client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = order_tracking_signals.CreateOrderTrackingSignalRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, order_tracking_signals.OrderTrackingSignal) - assert response.order_tracking_signal_id == 2519 - assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' - - -def test_create_order_tracking_signal_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = order_tracking_signals.CreateOrderTrackingSignalRequest( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_order_tracking_signal(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == order_tracking_signals.CreateOrderTrackingSignalRequest( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - -def test_create_order_tracking_signal_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc - request = {} - client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_order_tracking_signal(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_order_tracking_signal in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.AsyncMock() - mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_order_tracking_signal] = mock_rpc - - request = {} - await client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - await client.create_order_tracking_signal(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio', request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - )) - response = await client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = order_tracking_signals.CreateOrderTrackingSignalRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, order_tracking_signals.OrderTrackingSignal) - assert response.order_tracking_signal_id == 2519 - assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' - - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_async_from_dict(): - await test_create_order_tracking_signal_async(request_type=dict) - -def test_create_order_tracking_signal_field_headers(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = order_tracking_signals.CreateOrderTrackingSignalRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value = order_tracking_signals.OrderTrackingSignal() - client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_field_headers_async(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = order_tracking_signals.CreateOrderTrackingSignalRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) - await client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'parent=parent_value', - ) in kw['metadata'] - - -def test_create_order_tracking_signal_flattened(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = order_tracking_signals.OrderTrackingSignal() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_order_tracking_signal( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].order_tracking_signal_id - mock_val = 'order_tracking_signal_id_value' - assert arg == mock_val - - -def test_create_order_tracking_signal_flattened_error(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_order_tracking_signal( - order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_flattened_async(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = order_tracking_signals.OrderTrackingSignal() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_order_tracking_signal( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].order_tracking_signal_id - mock_val = 'order_tracking_signal_id_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_order_tracking_signal_flattened_error_async(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_order_tracking_signal( - order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - - -def test_create_order_tracking_signal_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc - - request = {} - client.create_order_tracking_signal(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_order_tracking_signal(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_order_tracking_signal_rest_required_fields(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): - transport_class = transports.OrderTrackingSignalsServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("order_tracking_signal_id", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = order_tracking_signals.OrderTrackingSignal() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - response = client.create_order_tracking_signal(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_order_tracking_signal_rest_unset_required_fields(): - transport = transports.OrderTrackingSignalsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_order_tracking_signal._get_unset_required_fields({}) - assert set(unset_fields) == (set(("orderTrackingSignalId", )) & set(("parent", "orderTrackingSignal", ))) - - -def test_create_order_tracking_signal_rest_flattened(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = order_tracking_signals.OrderTrackingSignal() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'accounts/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - - client.create_order_tracking_signal(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/ordertracking/v1beta/{parent=accounts/*}/ordertrackingsignals" % client.transport._host, args[1]) - - -def test_create_order_tracking_signal_rest_flattened_error(transport: str = 'rest'): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.create_order_tracking_signal( - order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OrderTrackingSignalsServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = OrderTrackingSignalsServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = OrderTrackingSignalsServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OrderTrackingSignalsServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = OrderTrackingSignalsServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.OrderTrackingSignalsServiceGrpcTransport, - transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, - transports.OrderTrackingSignalsServiceRestTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_kind_grpc(): - transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc")( - credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "grpc" - - -def test_initialize_client_w_grpc(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_order_tracking_signal_empty_call_grpc(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value = order_tracking_signals.OrderTrackingSignal() - client.create_order_tracking_signal(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() - - assert args[0] == request_msg - - -def test_transport_kind_grpc_asyncio(): - transport = OrderTrackingSignalsServiceAsyncClient.get_transport_class("grpc_asyncio")( - credentials=async_anonymous_credentials() - ) - assert transport.kind == "grpc_asyncio" - - -def test_initialize_client_w_grpc_asyncio(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -@pytest.mark.asyncio -async def test_create_order_tracking_signal_empty_call_grpc_asyncio(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - )) - await client.create_order_tracking_signal(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() - - assert args[0] == request_msg - - -def test_transport_kind_rest(): - transport = OrderTrackingSignalsServiceClient.get_transport_class("rest")( - credentials=ga_credentials.AnonymousCredentials() - ) - assert transport.kind == "rest" - - -def test_create_order_tracking_signal_rest_bad_request(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - # send a request that will satisfy transcoding - request_init = {'parent': 'accounts/sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = mock.Mock() - json_return_value = '' - response_value.json = mock.Mock(return_value={}) - response_value.status_code = 400 - response_value.request = mock.Mock() - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - client.create_order_tracking_signal(request) - - -@pytest.mark.parametrize("request_type", [ - order_tracking_signals.CreateOrderTrackingSignalRequest, - dict, -]) -def test_create_order_tracking_signal_rest_call_success(request_type): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'accounts/sample1'} - request_init["order_tracking_signal"] = {'order_tracking_signal_id': 2519, 'merchant_id': 1150, 'order_created_time': {'year': 433, 'month': 550, 'day': 318, 'hours': 561, 'minutes': 773, 'seconds': 751, 'nanos': 543, 'utc_offset': {'seconds': 751, 'nanos': 543}, 'time_zone': {'id': 'id_value', 'version': 'version_value'}}, 'order_id': 'order_id_value', 'shipping_info': [{'shipment_id': 'shipment_id_value', 'tracking_id': 'tracking_id_value', 'carrier': 'carrier_value', 'carrier_service': 'carrier_service_value', 'shipped_time': {}, 'earliest_delivery_promise_time': {}, 'latest_delivery_promise_time': {}, 'actual_delivery_time': {}, 'shipping_status': 1, 'origin_postal_code': 'origin_postal_code_value', 'origin_region_code': 'origin_region_code_value'}], 'line_items': [{'line_item_id': 'line_item_id_value', 'product_id': 'product_id_value', 'gtin': 'gtin_value', 'mpn': 'mpn_value', 'product_title': 'product_title_value', 'brand': 'brand_value', 'quantity': 895}], 'shipment_line_item_mapping': [{'shipment_id': 'shipment_id_value', 'line_item_id': 'line_item_id_value', 'quantity': 895}], 'customer_shipping_fee': {'amount_micros': 1408, 'currency_code': 'currency_code_value'}, 'delivery_postal_code': 'delivery_postal_code_value', 'delivery_region_code': 'delivery_region_code_value'} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = order_tracking_signals.CreateOrderTrackingSignalRequest.meta.fields["order_tracking_signal"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["order_tracking_signal"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["order_tracking_signal"][field])): - del request_init["order_tracking_signal"][field][i][subfield] - else: - del request_init["order_tracking_signal"][field][subfield] - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - ) - - # Wrap the value into a proper Response obj - response_value = mock.Mock() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') - req.return_value = response_value - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - response = client.create_order_tracking_signal(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, order_tracking_signals.OrderTrackingSignal) - assert response.order_tracking_signal_id == 2519 - assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_order_tracking_signal_rest_interceptors(null_interceptor): - transport = transports.OrderTrackingSignalsServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OrderTrackingSignalsServiceRestInterceptor(), - ) - client = OrderTrackingSignalsServiceClient(transport=transport) - - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal") as post, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "pre_create_order_tracking_signal") as pre: - pre.assert_not_called() - post.assert_not_called() - post_with_metadata.assert_not_called() - pb_message = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(order_tracking_signals.CreateOrderTrackingSignalRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = mock.Mock() - req.return_value.status_code = 200 - req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = order_tracking_signals.OrderTrackingSignal.to_json(order_tracking_signals.OrderTrackingSignal()) - req.return_value.content = return_value - - request = order_tracking_signals.CreateOrderTrackingSignalRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = order_tracking_signals.OrderTrackingSignal() - post_with_metadata.return_value = order_tracking_signals.OrderTrackingSignal(), metadata - - client.create_order_tracking_signal(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - post_with_metadata.assert_called_once() - -def test_initialize_client_w_rest(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - assert client is not None - - -# This test is a coverage failsafe to make sure that totally empty calls, -# i.e. request == None and no flattened fields passed, work. -def test_create_order_tracking_signal_empty_call_rest(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the actual call, and fake the request. - with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - client.create_order_tracking_signal(request=None) - - # Establish that the underlying stub method was called. - call.assert_called() - _, args, _ = call.mock_calls[0] - request_msg = order_tracking_signals.CreateOrderTrackingSignalRequest() - - assert args[0] == request_msg - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.OrderTrackingSignalsServiceGrpcTransport, - ) - -def test_order_tracking_signals_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.OrderTrackingSignalsServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_order_tracking_signals_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.OrderTrackingSignalsServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_order_tracking_signal', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_order_tracking_signals_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.OrderTrackingSignalsServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), - quota_project_id="octopus", - ) - - -def test_order_tracking_signals_service_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.shopping.merchant_ordertracking_v1beta.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.OrderTrackingSignalsServiceTransport() - adc.assert_called_once() - - -def test_order_tracking_signals_service_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - OrderTrackingSignalsServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.OrderTrackingSignalsServiceGrpcTransport, - transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, - ], -) -def test_order_tracking_signals_service_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/content',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.OrderTrackingSignalsServiceGrpcTransport, - transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, - transports.OrderTrackingSignalsServiceRestTransport, - ], -) -def test_order_tracking_signals_service_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.OrderTrackingSignalsServiceGrpcTransport, grpc_helpers), - (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_order_tracking_signals_service_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "merchantapi.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/content', -), - scopes=["1", "2"], - default_host="merchantapi.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) -def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - -def test_order_tracking_signals_service_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.OrderTrackingSignalsServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_order_tracking_signals_service_host_no_port(transport_name): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://merchantapi.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_order_tracking_signals_service_host_with_port(transport_name): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'merchantapi.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://merchantapi.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_order_tracking_signals_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = OrderTrackingSignalsServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = OrderTrackingSignalsServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.create_order_tracking_signal._session - session2 = client2.transport.create_order_tracking_signal._session - assert session1 != session2 -def test_order_tracking_signals_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.OrderTrackingSignalsServiceGrpcTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -def test_order_tracking_signals_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) -def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) -def test_order_tracking_signals_service_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_account_path(): - account = "squid" - expected = "accounts/{account}".format(account=account, ) - actual = OrderTrackingSignalsServiceClient.account_path(account) - assert expected == actual - - -def test_parse_account_path(): - expected = { - "account": "clam", - } - path = OrderTrackingSignalsServiceClient.account_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_account_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "whelk" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = OrderTrackingSignalsServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "octopus", - } - path = OrderTrackingSignalsServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "oyster" - expected = "folders/{folder}".format(folder=folder, ) - actual = OrderTrackingSignalsServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nudibranch", - } - path = OrderTrackingSignalsServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization, ) - actual = OrderTrackingSignalsServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "mussel", - } - path = OrderTrackingSignalsServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "winkle" - expected = "projects/{project}".format(project=project, ) - actual = OrderTrackingSignalsServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "nautilus", - } - path = OrderTrackingSignalsServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "scallop" - location = "abalone" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = OrderTrackingSignalsServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "squid", - "location": "clam", - } - path = OrderTrackingSignalsServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = OrderTrackingSignalsServiceClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_with_default_client_info(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = OrderTrackingSignalsServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - -def test_transport_close_grpc(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" - ) - with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - - -@pytest.mark.asyncio -async def test_transport_close_grpc_asyncio(): - client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio" - ) - with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - - -def test_transport_close_rest(): - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" - ) - with mock.patch.object(type(getattr(client.transport, "_session")), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - - -def test_client_ctx(): - transports = [ - 'rest', - 'grpc', - ] - for transport in transports: - client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - # Test client calls underlying transport. - with mock.patch.object(type(client.transport), "close") as close: - close.assert_not_called() - with client: - pass - close.assert_called() - -@pytest.mark.parametrize("client_class,transport_class", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) diff --git a/packages/google-shopping-merchant-ordertracking/docs/index.rst b/packages/google-shopping-merchant-ordertracking/docs/index.rst index d5e7aa30c2b5..f737621abf52 100644 --- a/packages/google-shopping-merchant-ordertracking/docs/index.rst +++ b/packages/google-shopping-merchant-ordertracking/docs/index.rst @@ -2,6 +2,9 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Merchant API. +By default, you will get version ``merchant_ordertracking_v1beta``. + API Reference ------------- @@ -11,6 +14,14 @@ API Reference merchant_ordertracking_v1beta/services_ merchant_ordertracking_v1beta/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_ordertracking_v1/services_ + merchant_ordertracking_v1/types_ + Changelog --------- diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst b/packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst rename to packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/order_tracking_signals_service.rst diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst b/packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/services_.rst similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/services_.rst rename to packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/services_.rst diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst b/packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/types_.rst similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/docs/merchant_ordertracking_v1/types_.rst rename to packages/google-shopping-merchant-ordertracking/docs/merchant_ordertracking_v1/types_.rst diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/__init__.py similarity index 61% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/__init__.py index 53765b98bfc9..4feae8300d69 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/__init__.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/__init__.py @@ -18,15 +18,18 @@ __version__ = package_version.__version__ -from .services.order_tracking_signals_service import OrderTrackingSignalsServiceClient -from .services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient - -from .types.order_tracking_signals import CreateOrderTrackingSignalRequest -from .types.order_tracking_signals import OrderTrackingSignal +from .services.order_tracking_signals_service import ( + OrderTrackingSignalsServiceAsyncClient, + OrderTrackingSignalsServiceClient, +) +from .types.order_tracking_signals import ( + CreateOrderTrackingSignalRequest, + OrderTrackingSignal, +) __all__ = ( - 'OrderTrackingSignalsServiceAsyncClient', -'CreateOrderTrackingSignalRequest', -'OrderTrackingSignal', -'OrderTrackingSignalsServiceClient', + "OrderTrackingSignalsServiceAsyncClient", + "CreateOrderTrackingSignalRequest", + "OrderTrackingSignal", + "OrderTrackingSignalsServiceClient", ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/gapic_metadata.json similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/gapic_metadata.json rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/gapic_metadata.json diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/gapic_version.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/gapic_version.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/gapic_version.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/py.typed similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking/py.typed rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/py.typed diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/__init__.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/__init__.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/__init__.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py similarity index 89% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py index 15b29929ccad..68517730066b 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/__init__.py @@ -13,10 +13,10 @@ # See the License for the specific language governing permissions and # limitations under the License. # -from .client import OrderTrackingSignalsServiceClient from .async_client import OrderTrackingSignalsServiceAsyncClient +from .client import OrderTrackingSignalsServiceClient __all__ = ( - 'OrderTrackingSignalsServiceClient', - 'OrderTrackingSignalsServiceAsyncClient', + "OrderTrackingSignalsServiceClient", + "OrderTrackingSignalsServiceAsyncClient", ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py similarity index 78% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py index ba5e06133757..4a3b4cefeb3a 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/async_client.py @@ -13,42 +13,56 @@ # See the License for the specific language governing permissions and # limitations under the License. # -import logging as std_logging from collections import OrderedDict +import logging as std_logging import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) -from google.api_core.client_options import ClientOptions from google.api_core import exceptions as core_exceptions from google.api_core import gapic_v1 from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore +from google.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore import google.protobuf +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version try: OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore -from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals from google.shopping.type.types import types from google.type import datetime_pb2 # type: ignore -from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals + from .client import OrderTrackingSignalsServiceClient +from .transports.base import DEFAULT_CLIENT_INFO, OrderTrackingSignalsServiceTransport +from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport try: from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False _LOGGER = std_logging.getLogger(__name__) + class OrderTrackingSignalsServiceAsyncClient: """Service to serve order tracking signals public API.""" @@ -58,21 +72,45 @@ class OrderTrackingSignalsServiceAsyncClient: # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. DEFAULT_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_ENDPOINT DEFAULT_MTLS_ENDPOINT = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - _DEFAULT_ENDPOINT_TEMPLATE = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_ENDPOINT_TEMPLATE = ( + OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE + ) _DEFAULT_UNIVERSE = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE account_path = staticmethod(OrderTrackingSignalsServiceClient.account_path) - parse_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_account_path) - common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_organization_path) - common_project_path = staticmethod(OrderTrackingSignalsServiceClient.common_project_path) - parse_common_project_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_project_path) - common_location_path = staticmethod(OrderTrackingSignalsServiceClient.common_location_path) - parse_common_location_path = staticmethod(OrderTrackingSignalsServiceClient.parse_common_location_path) + parse_account_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_account_path + ) + common_billing_account_path = staticmethod( + OrderTrackingSignalsServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod( + OrderTrackingSignalsServiceClient.common_folder_path + ) + parse_common_folder_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + OrderTrackingSignalsServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod( + OrderTrackingSignalsServiceClient.common_project_path + ) + parse_common_project_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_common_project_path + ) + common_location_path = staticmethod( + OrderTrackingSignalsServiceClient.common_location_path + ) + parse_common_location_path = staticmethod( + OrderTrackingSignalsServiceClient.parse_common_location_path + ) @classmethod def from_service_account_info(cls, info: dict, *args, **kwargs): @@ -108,7 +146,9 @@ def from_service_account_file(cls, filename: str, *args, **kwargs): from_service_account_json = from_service_account_file @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[ClientOptions] = None + ): """Return the API endpoint and client cert source for mutual TLS. The client cert source is determined in the following order: @@ -171,12 +211,20 @@ def universe_domain(self) -> str: get_transport_class = OrderTrackingSignalsServiceClient.get_transport_class - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + OrderTrackingSignalsServiceTransport, + Callable[..., OrderTrackingSignalsServiceTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: """Instantiates the order tracking signals service async client. Args: @@ -231,32 +279,42 @@ def __init__(self, *, transport=transport, client_options=client_options, client_info=client_info, - ) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER _LOGGER.debug( "Created client `google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceAsyncClient`.", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", - "universeDomain": getattr(self._client._transport._credentials, "universe_domain", ""), + "universeDomain": getattr( + self._client._transport._credentials, "universe_domain", "" + ), "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._client._transport, "_credentials") else { + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._client._transport, "_credentials") + else { "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "credentialsType": None, - } + }, ) - async def create_order_tracking_signal(self, - request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, - *, - parent: Optional[str] = None, - order_tracking_signal_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> order_tracking_signals.OrderTrackingSignal: + async def create_order_tracking_signal( + self, + request: Optional[ + Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: r"""Creates new order tracking signal. .. code-block:: python @@ -336,14 +394,20 @@ async def sample_create_order_tracking_signal(): # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [parent, order_tracking_signal_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. - if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + if not isinstance( + request, order_tracking_signals.CreateOrderTrackingSignalRequest + ): request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) # If we have keyword arguments corresponding to fields on the @@ -355,14 +419,14 @@ async def sample_create_order_tracking_signal(): # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_order_tracking_signal] + rpc = self._client._transport._wrapped_methods[ + self._client._transport.create_order_tracking_signal + ] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), ) # Validate the universe domain. @@ -385,12 +449,13 @@ async def __aenter__(self) -> "OrderTrackingSignalsServiceAsyncClient": async def __aexit__(self, exc_type, exc, tb): await self.transport.close() -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) -if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ -__all__ = ( - "OrderTrackingSignalsServiceAsyncClient", -) +__all__ = ("OrderTrackingSignalsServiceAsyncClient",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py similarity index 76% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py index 6ca9cd9cf31d..0a2a45d90ba7 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/client.py @@ -19,22 +19,34 @@ import logging as std_logging import os import re -from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) import warnings -from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version - from google.api_core import client_options as client_options_lib from google.api_core import exceptions as core_exceptions from google.api_core import gapic_v1 from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore import google.protobuf +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version + try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] except AttributeError: # pragma: NO COVER @@ -42,16 +54,19 @@ try: from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False _LOGGER = std_logging.getLogger(__name__) -from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals from google.shopping.type.types import types from google.type import datetime_pb2 # type: ignore -from .transports.base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals + +from .transports.base import DEFAULT_CLIENT_INFO, OrderTrackingSignalsServiceTransport from .transports.grpc import OrderTrackingSignalsServiceGrpcTransport from .transports.grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport from .transports.rest import OrderTrackingSignalsServiceRestTransport @@ -64,14 +79,20 @@ class OrderTrackingSignalsServiceClientMeta(type): support objects (e.g. transport) without polluting the client instance objects. """ - _transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] _transport_registry["grpc"] = OrderTrackingSignalsServiceGrpcTransport - _transport_registry["grpc_asyncio"] = OrderTrackingSignalsServiceGrpcAsyncIOTransport + _transport_registry[ + "grpc_asyncio" + ] = OrderTrackingSignalsServiceGrpcAsyncIOTransport _transport_registry["rest"] = OrderTrackingSignalsServiceRestTransport - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[OrderTrackingSignalsServiceTransport]: + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[OrderTrackingSignalsServiceTransport]: """Returns an appropriate transport class. Args: @@ -90,7 +111,9 @@ def get_transport_class(cls, return next(iter(cls._transport_registry.values())) -class OrderTrackingSignalsServiceClient(metaclass=OrderTrackingSignalsServiceClientMeta): +class OrderTrackingSignalsServiceClient( + metaclass=OrderTrackingSignalsServiceClientMeta +): """Service to serve order tracking signals public API.""" @staticmethod @@ -163,8 +186,7 @@ def from_service_account_file(cls, filename: str, *args, **kwargs): Returns: OrderTrackingSignalsServiceClient: The constructed client. """ - credentials = service_account.Credentials.from_service_account_file( - filename) + credentials = service_account.Credentials.from_service_account_file(filename) kwargs["credentials"] = credentials return cls(*args, **kwargs) @@ -181,73 +203,101 @@ def transport(self) -> OrderTrackingSignalsServiceTransport: return self._transport @staticmethod - def account_path(account: str,) -> str: + def account_path( + account: str, + ) -> str: """Returns a fully-qualified account string.""" - return "accounts/{account}".format(account=account, ) + return "accounts/{account}".format( + account=account, + ) @staticmethod - def parse_account_path(path: str) -> Dict[str,str]: + def parse_account_path(path: str) -> Dict[str, str]: """Parses a account path into its component segments.""" m = re.match(r"^accounts/(?P.+?)$", path) return m.groupdict() if m else {} @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: + def common_billing_account_path( + billing_account: str, + ) -> str: """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: + def parse_common_billing_account_path(path: str) -> Dict[str, str]: """Parse a billing_account path into its component segments.""" m = re.match(r"^billingAccounts/(?P.+?)$", path) return m.groupdict() if m else {} @staticmethod - def common_folder_path(folder: str, ) -> str: + def common_folder_path( + folder: str, + ) -> str: """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) + return "folders/{folder}".format( + folder=folder, + ) @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: + def parse_common_folder_path(path: str) -> Dict[str, str]: """Parse a folder path into its component segments.""" m = re.match(r"^folders/(?P.+?)$", path) return m.groupdict() if m else {} @staticmethod - def common_organization_path(organization: str, ) -> str: + def common_organization_path( + organization: str, + ) -> str: """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) + return "organizations/{organization}".format( + organization=organization, + ) @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: + def parse_common_organization_path(path: str) -> Dict[str, str]: """Parse a organization path into its component segments.""" m = re.match(r"^organizations/(?P.+?)$", path) return m.groupdict() if m else {} @staticmethod - def common_project_path(project: str, ) -> str: + def common_project_path( + project: str, + ) -> str: """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) + return "projects/{project}".format( + project=project, + ) @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: + def parse_common_project_path(path: str) -> Dict[str, str]: """Parse a project path into its component segments.""" m = re.match(r"^projects/(?P.+?)$", path) return m.groupdict() if m else {} @staticmethod - def common_location_path(project: str, location: str, ) -> str: + def common_location_path( + project: str, + location: str, + ) -> str: """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: + def parse_common_location_path(path: str) -> Dict[str, str]: """Parse a location path into its component segments.""" m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) return m.groupdict() if m else {} @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): """Deprecated. Return the API endpoint and client cert source for mutual TLS. The client cert source is determined in the following order: @@ -279,16 +329,22 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio google.auth.exceptions.MutualTLSChannelError: If any errors happen. """ - warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", - DeprecationWarning) + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) if client_options is None: client_options = client_options_lib.ClientOptions() use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) # Figure out the client cert source to use. client_cert_source = None @@ -301,7 +357,9 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio # Figure out which api endpoint to use. if client_options.api_endpoint is not None: api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): api_endpoint = cls.DEFAULT_MTLS_ENDPOINT else: api_endpoint = cls.DEFAULT_ENDPOINT @@ -322,13 +380,19 @@ def _read_environment_variables(): google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT is not any of ["auto", "never", "always"]. """ - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) return use_client_cert == "true", use_mtls_endpoint, universe_domain_env @staticmethod @@ -351,7 +415,9 @@ def _get_client_cert_source(provided_cert_source, use_cert_flag): return client_cert_source @staticmethod - def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): """Return the API endpoint used by the client. Args: @@ -367,17 +433,27 @@ def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtl """ if api_override is not None: api_endpoint = api_override - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): _default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE if universe_domain != _default_universe: - raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) api_endpoint = OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT else: - api_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + api_endpoint = ( + OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + ) return api_endpoint @staticmethod - def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: """Return the universe domain used by the client. Args: @@ -413,15 +489,18 @@ def _validate_universe_domain(self): return True def _add_cred_info_for_auth_errors( - self, - error: core_exceptions.GoogleAPICallError + self, error: core_exceptions.GoogleAPICallError ) -> None: """Adds credential info string to error details for 401/403/404 errors. Args: error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. """ - if error.code not in [HTTPStatus.UNAUTHORIZED, HTTPStatus.FORBIDDEN, HTTPStatus.NOT_FOUND]: + if error.code not in [ + HTTPStatus.UNAUTHORIZED, + HTTPStatus.FORBIDDEN, + HTTPStatus.NOT_FOUND, + ]: return cred = self._transport._credentials @@ -454,12 +533,20 @@ def universe_domain(self) -> str: """ return self._universe_domain - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OrderTrackingSignalsServiceTransport, Callable[..., OrderTrackingSignalsServiceTransport]]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + OrderTrackingSignalsServiceTransport, + Callable[..., OrderTrackingSignalsServiceTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: """Instantiates the order tracking signals service client. Args: @@ -514,14 +601,26 @@ def __init__(self, *, self._client_options = client_options_lib.from_dict(self._client_options) if self._client_options is None: self._client_options = client_options_lib.ClientOptions() - self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) - universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + universe_domain_opt = getattr(self._client_options, "universe_domain", None) - self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OrderTrackingSignalsServiceClient._read_environment_variables() - self._client_cert_source = OrderTrackingSignalsServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) - self._universe_domain = OrderTrackingSignalsServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) - self._api_endpoint = None # updated below, depending on `transport` + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = OrderTrackingSignalsServiceClient._read_environment_variables() + self._client_cert_source = ( + OrderTrackingSignalsServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + ) + self._universe_domain = OrderTrackingSignalsServiceClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + self._api_endpoint = None # updated below, depending on `transport` # Initialize the universe domain validation. self._is_universe_domain_valid = False @@ -532,7 +631,9 @@ def __init__(self, *, api_key_value = getattr(self._client_options, "api_key", None) if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) # Save or instantiate the transport. # Ordinarily, we provide the transport, but allowing a custom transport @@ -541,8 +642,10 @@ def __init__(self, *, if transport_provided: # transport is a OrderTrackingSignalsServiceTransport instance. if credentials or self._client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) if self._client_options.scopes: raise ValueError( "When providing a transport instance, provide its scopes " @@ -551,23 +654,35 @@ def __init__(self, *, self._transport = cast(OrderTrackingSignalsServiceTransport, transport) self._api_endpoint = self._transport.host - self._api_endpoint = (self._api_endpoint or - OrderTrackingSignalsServiceClient._get_api_endpoint( + self._api_endpoint = ( + self._api_endpoint + or OrderTrackingSignalsServiceClient._get_api_endpoint( self._client_options.api_endpoint, self._client_cert_source, self._universe_domain, - self._use_mtls_endpoint)) + self._use_mtls_endpoint, + ) + ) if not transport_provided: import google.auth._default # type: ignore - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) - transport_init: Union[Type[OrderTrackingSignalsServiceTransport], Callable[..., OrderTrackingSignalsServiceTransport]] = ( + transport_init: Union[ + Type[OrderTrackingSignalsServiceTransport], + Callable[..., OrderTrackingSignalsServiceTransport], + ] = ( OrderTrackingSignalsServiceClient.get_transport_class(transport) if isinstance(transport, str) or transport is None - else cast(Callable[..., OrderTrackingSignalsServiceTransport], transport) + else cast( + Callable[..., OrderTrackingSignalsServiceTransport], transport + ) ) # initialize with the provided callable or the passed in class self._transport = transport_init( @@ -583,29 +698,40 @@ def __init__(self, *, ) if "async" not in str(self._transport): - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG): # pragma: NO COVER + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER _LOGGER.debug( "Created client `google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient`.", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", - "universeDomain": getattr(self._transport._credentials, "universe_domain", ""), + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", - "credentialsInfo": getattr(self.transport._credentials, "get_cred_info", lambda: None)(), - } if hasattr(self._transport, "_credentials") else { + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "credentialsType": None, - } + }, ) - def create_order_tracking_signal(self, - request: Optional[Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict]] = None, - *, - parent: Optional[str] = None, - order_tracking_signal_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), - ) -> order_tracking_signals.OrderTrackingSignal: + def create_order_tracking_signal( + self, + request: Optional[ + Union[order_tracking_signals.CreateOrderTrackingSignalRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + order_tracking_signal_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: r"""Creates new order tracking signal. .. code-block:: python @@ -685,14 +811,20 @@ def sample_create_order_tracking_signal(): # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. flattened_params = [parent, order_tracking_signal_id] - has_flattened_params = len([param for param in flattened_params if param is not None]) > 0 + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. - if not isinstance(request, order_tracking_signals.CreateOrderTrackingSignalRequest): + if not isinstance( + request, order_tracking_signals.CreateOrderTrackingSignalRequest + ): request = order_tracking_signals.CreateOrderTrackingSignalRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. @@ -703,14 +835,14 @@ def sample_create_order_tracking_signal(): # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_order_tracking_signal] + rpc = self._transport._wrapped_methods[ + self._transport.create_order_tracking_signal + ] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), ) # Validate the universe domain. @@ -741,16 +873,11 @@ def __exit__(self, type, value, traceback): self.transport.close() - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ -__all__ = ( - "OrderTrackingSignalsServiceClient", -) +__all__ = ("OrderTrackingSignalsServiceClient",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/README.rst diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py similarity index 58% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py index c1246dfdc064..2166d99c72aa 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/order_tracking_signals_service/transports/__init__.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/__init__.py @@ -19,20 +19,23 @@ from .base import OrderTrackingSignalsServiceTransport from .grpc import OrderTrackingSignalsServiceGrpcTransport from .grpc_asyncio import OrderTrackingSignalsServiceGrpcAsyncIOTransport -from .rest import OrderTrackingSignalsServiceRestTransport -from .rest import OrderTrackingSignalsServiceRestInterceptor - +from .rest import ( + OrderTrackingSignalsServiceRestInterceptor, + OrderTrackingSignalsServiceRestTransport, +) # Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] -_transport_registry['grpc'] = OrderTrackingSignalsServiceGrpcTransport -_transport_registry['grpc_asyncio'] = OrderTrackingSignalsServiceGrpcAsyncIOTransport -_transport_registry['rest'] = OrderTrackingSignalsServiceRestTransport +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[OrderTrackingSignalsServiceTransport]] +_transport_registry["grpc"] = OrderTrackingSignalsServiceGrpcTransport +_transport_registry["grpc_asyncio"] = OrderTrackingSignalsServiceGrpcAsyncIOTransport +_transport_registry["rest"] = OrderTrackingSignalsServiceRestTransport __all__ = ( - 'OrderTrackingSignalsServiceTransport', - 'OrderTrackingSignalsServiceGrpcTransport', - 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', - 'OrderTrackingSignalsServiceRestTransport', - 'OrderTrackingSignalsServiceRestInterceptor', + "OrderTrackingSignalsServiceTransport", + "OrderTrackingSignalsServiceGrpcTransport", + "OrderTrackingSignalsServiceGrpcAsyncIOTransport", + "OrderTrackingSignalsServiceRestTransport", + "OrderTrackingSignalsServiceRestInterceptor", ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py similarity index 69% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py index 1bcd7198776c..5d71ba95f2e0 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/base.py @@ -16,20 +16,21 @@ import abc from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version - -import google.auth # type: ignore import google.api_core from google.api_core import exceptions as core_exceptions from google.api_core import gapic_v1 from google.api_core import retry as retries +import google.auth # type: ignore from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore +from google.oauth2 import service_account # type: ignore import google.protobuf +from google.shopping.merchant_ordertracking_v1 import gapic_version as package_version from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ @@ -38,24 +39,23 @@ class OrderTrackingSignalsServiceTransport(abc.ABC): """Abstract transport class for OrderTrackingSignalsService.""" - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/content', - ) + AUTH_SCOPES = ("https://www.googleapis.com/auth/content",) - DEFAULT_HOST: str = 'merchantapi.googleapis.com' + DEFAULT_HOST: str = "merchantapi.googleapis.com" def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: """Instantiate the transport. Args: @@ -91,30 +91,38 @@ def __init__( # If no credentials are provided, then determine the appropriate # defaults. if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) if credentials_file is not None: credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) elif credentials is None and not self._ignore_credentials: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) # Don't apply audience if the credentials file passed from user. if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): credentials = credentials.with_always_use_jwt_access(True) # Save the credentials. self._credentials = credentials # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' + if ":" not in host: + host += ":443" self._host = host @property @@ -129,24 +137,27 @@ def _prep_wrapped_messages(self, client_info): default_timeout=None, client_info=client_info, ), - } + } def close(self): """Closes resources associated with the transport. - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! """ raise NotImplementedError() @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - Union[ - order_tracking_signals.OrderTrackingSignal, - Awaitable[order_tracking_signals.OrderTrackingSignal] - ]]: + def create_order_tracking_signal( + self, + ) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Union[ + order_tracking_signals.OrderTrackingSignal, + Awaitable[order_tracking_signals.OrderTrackingSignal], + ], + ]: raise NotImplementedError() @property @@ -154,6 +165,4 @@ def kind(self) -> str: raise NotImplementedError() -__all__ = ( - 'OrderTrackingSignalsServiceTransport', -) +__all__ = ("OrderTrackingSignalsServiceTransport",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py similarity index 85% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py index 18c853e994e0..f754d7f0b4d6 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc.py @@ -16,25 +16,25 @@ import json import logging as std_logging import pickle -import warnings from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore from google.protobuf.json_format import MessageToJson import google.protobuf.message - import grpc # type: ignore import proto # type: ignore from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +from .base import DEFAULT_CLIENT_INFO, OrderTrackingSignalsServiceTransport try: from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False @@ -44,7 +44,9 @@ class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) if logging_enabled: # pragma: NO COVER request_metadata = client_call_details.metadata if isinstance(request, proto.Message): @@ -65,7 +67,7 @@ def intercept_unary_unary(self, continuation, client_call_details, request): } _LOGGER.debug( f"Sending request for {client_call_details.method}", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": str(client_call_details.method), "request": grpc_request, @@ -76,7 +78,11 @@ def intercept_unary_unary(self, continuation, client_call_details, request): if logging_enabled: # pragma: NO COVER response_metadata = response.trailing_metadata() # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) result = response.result() if isinstance(result, proto.Message): response_payload = type(result).to_json(result) @@ -91,7 +97,7 @@ def intercept_unary_unary(self, continuation, client_call_details, request): } _LOGGER.debug( f"Received response for {client_call_details.method}.", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": client_call_details.method, "response": grpc_response, @@ -113,23 +119,26 @@ class OrderTrackingSignalsServiceGrpcTransport(OrderTrackingSignalsServiceTransp It sends protocol buffers over the wire using gRPC (which is built on top of HTTP/2); the ``grpcio`` package must be installed. """ + _stubs: Dict[str, Callable] - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: @@ -251,19 +260,23 @@ def __init__(self, *, ) self._interceptor = _LoggingClientInterceptor() - self._logged_channel = grpc.intercept_channel(self._grpc_channel, self._interceptor) + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) # Wrap messages. This must be done after self._logged_channel exists self._prep_wrapped_messages(client_info) @classmethod - def create_channel(cls, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: """Create and return a gRPC channel object. Args: host (Optional[str]): The host for the channel to use. @@ -298,19 +311,21 @@ def create_channel(cls, default_scopes=cls.AUTH_SCOPES, scopes=scopes, default_host=cls.DEFAULT_HOST, - **kwargs + **kwargs, ) @property def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ + """Return the channel designed to connect to this service.""" return self._grpc_channel @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - order_tracking_signals.OrderTrackingSignal]: + def create_order_tracking_signal( + self, + ) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal, + ]: r"""Return a callable for the create order tracking signal method over gRPC. Creates new order tracking signal. @@ -325,13 +340,15 @@ def create_order_tracking_signal(self) -> Callable[ # the request. # gRPC handles serialization and deserialization, so we just need # to pass in the functions for each. - if 'create_order_tracking_signal' not in self._stubs: - self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( - '/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal', + if "create_order_tracking_signal" not in self._stubs: + self._stubs[ + "create_order_tracking_signal" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal", request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, ) - return self._stubs['create_order_tracking_signal'] + return self._stubs["create_order_tracking_signal"] def close(self): self._logged_channel.close() @@ -341,6 +358,4 @@ def kind(self) -> str: return "grpc" -__all__ = ( - 'OrderTrackingSignalsServiceGrpcTransport', -) +__all__ = ("OrderTrackingSignalsServiceGrpcTransport",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py similarity index 83% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py index 50a5069c56fc..1251ea3d0eb1 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/grpc_asyncio.py @@ -15,30 +15,30 @@ # import inspect import json -import pickle import logging as std_logging -import warnings +import pickle from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore from google.auth.transport.grpc import SslCredentials # type: ignore from google.protobuf.json_format import MessageToJson import google.protobuf.message - -import grpc # type: ignore -import proto # type: ignore +import grpc # type: ignore from grpc.experimental import aio # type: ignore +import proto # type: ignore from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO + +from .base import DEFAULT_CLIENT_INFO, OrderTrackingSignalsServiceTransport from .grpc import OrderTrackingSignalsServiceGrpcTransport try: from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False @@ -46,9 +46,13 @@ _LOGGER = std_logging.getLogger(__name__) -class _LoggingClientAIOInterceptor(grpc.aio.UnaryUnaryClientInterceptor): # pragma: NO COVER +class _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER async def intercept_unary_unary(self, continuation, client_call_details, request): - logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(std_logging.DEBUG) + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) if logging_enabled: # pragma: NO COVER request_metadata = client_call_details.metadata if isinstance(request, proto.Message): @@ -69,7 +73,7 @@ async def intercept_unary_unary(self, continuation, client_call_details, request } _LOGGER.debug( f"Sending request for {client_call_details.method}", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": str(client_call_details.method), "request": grpc_request, @@ -80,7 +84,11 @@ async def intercept_unary_unary(self, continuation, client_call_details, request if logging_enabled: # pragma: NO COVER response_metadata = await response.trailing_metadata() # Convert gRPC metadata `` to list of tuples - metadata = dict([(k, str(v)) for k, v in response_metadata]) if response_metadata else None + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) result = await response if isinstance(result, proto.Message): response_payload = type(result).to_json(result) @@ -95,7 +103,7 @@ async def intercept_unary_unary(self, continuation, client_call_details, request } _LOGGER.debug( f"Received response to rpc {client_call_details.method}.", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": str(client_call_details.method), "response": grpc_response, @@ -105,7 +113,9 @@ async def intercept_unary_unary(self, continuation, client_call_details, request return response -class OrderTrackingSignalsServiceGrpcAsyncIOTransport(OrderTrackingSignalsServiceTransport): +class OrderTrackingSignalsServiceGrpcAsyncIOTransport( + OrderTrackingSignalsServiceTransport +): """gRPC AsyncIO backend transport for OrderTrackingSignalsService. Service to serve order tracking signals public API. @@ -122,13 +132,15 @@ class OrderTrackingSignalsServiceGrpcAsyncIOTransport(OrderTrackingSignalsServic _stubs: Dict[str, Callable] = {} @classmethod - def create_channel(cls, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: """Create and return a gRPC AsyncIO channel object. Args: host (Optional[str]): The host for the channel to use. @@ -158,24 +170,26 @@ def create_channel(cls, default_scopes=cls.AUTH_SCOPES, scopes=scopes, default_host=cls.DEFAULT_HOST, - **kwargs + **kwargs, ) - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: @@ -299,7 +313,9 @@ def __init__(self, *, self._interceptor = _LoggingClientAIOInterceptor() self._grpc_channel._unary_unary_interceptors.append(self._interceptor) self._logged_channel = self._grpc_channel - self._wrap_with_kind = "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) # Wrap messages. This must be done after self._logged_channel exists self._prep_wrapped_messages(client_info) @@ -314,9 +330,12 @@ def grpc_channel(self) -> aio.Channel: return self._grpc_channel @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - Awaitable[order_tracking_signals.OrderTrackingSignal]]: + def create_order_tracking_signal( + self, + ) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + Awaitable[order_tracking_signals.OrderTrackingSignal], + ]: r"""Return a callable for the create order tracking signal method over gRPC. Creates new order tracking signal. @@ -331,16 +350,18 @@ def create_order_tracking_signal(self) -> Callable[ # the request. # gRPC handles serialization and deserialization, so we just need # to pass in the functions for each. - if 'create_order_tracking_signal' not in self._stubs: - self._stubs['create_order_tracking_signal'] = self._logged_channel.unary_unary( - '/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal', + if "create_order_tracking_signal" not in self._stubs: + self._stubs[ + "create_order_tracking_signal" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService/CreateOrderTrackingSignal", request_serializer=order_tracking_signals.CreateOrderTrackingSignalRequest.serialize, response_deserializer=order_tracking_signals.OrderTrackingSignal.deserialize, ) - return self._stubs['create_order_tracking_signal'] + return self._stubs["create_order_tracking_signal"] def _prep_wrapped_messages(self, client_info): - """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" self._wrapped_methods = { self.create_order_tracking_signal: self._wrap_method( self.create_order_tracking_signal, @@ -362,6 +383,4 @@ def kind(self) -> str: return "grpc_asyncio" -__all__ = ( - 'OrderTrackingSignalsServiceGrpcAsyncIOTransport', -) +__all__ = ("OrderTrackingSignalsServiceGrpcAsyncIOTransport",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py similarity index 67% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py index 95be32929e80..bbab3d27dc94 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest.py @@ -13,31 +13,25 @@ # See the License for the specific language governing permissions and # limitations under the License. # -import logging +import dataclasses import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings -from google.auth.transport.requests import AuthorizedSession # type: ignore -from google.auth import credentials as ga_credentials # type: ignore from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import gapic_v1 +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore import google.protobuf - from google.protobuf import json_format - from requests import __version__ as requests_version -import dataclasses -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals - -from .rest_base import _BaseOrderTrackingSignalsServiceRestTransport from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseOrderTrackingSignalsServiceRestTransport try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] @@ -46,6 +40,7 @@ try: from google.api_core import client_logging # type: ignore + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER except ImportError: # pragma: NO COVER CLIENT_LOGGING_SUPPORTED = False @@ -90,7 +85,15 @@ def post_create_order_tracking_signal(self, response): """ - def pre_create_order_tracking_signal(self, request: order_tracking_signals.CreateOrderTrackingSignalRequest, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.CreateOrderTrackingSignalRequest, Sequence[Tuple[str, Union[str, bytes]]]]: + + def pre_create_order_tracking_signal( + self, + request: order_tracking_signals.CreateOrderTrackingSignalRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + order_tracking_signals.CreateOrderTrackingSignalRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: """Pre-rpc interceptor for create_order_tracking_signal Override in a subclass to manipulate the request or metadata @@ -98,7 +101,9 @@ def pre_create_order_tracking_signal(self, request: order_tracking_signals.Creat """ return request, metadata - def post_create_order_tracking_signal(self, response: order_tracking_signals.OrderTrackingSignal) -> order_tracking_signals.OrderTrackingSignal: + def post_create_order_tracking_signal( + self, response: order_tracking_signals.OrderTrackingSignal + ) -> order_tracking_signals.OrderTrackingSignal: """Post-rpc interceptor for create_order_tracking_signal DEPRECATED. Please use the `post_create_order_tracking_signal_with_metadata` @@ -111,7 +116,14 @@ def post_create_order_tracking_signal(self, response: order_tracking_signals.Ord """ return response - def post_create_order_tracking_signal_with_metadata(self, response: order_tracking_signals.OrderTrackingSignal, metadata: Sequence[Tuple[str, Union[str, bytes]]]) -> Tuple[order_tracking_signals.OrderTrackingSignal, Sequence[Tuple[str, Union[str, bytes]]]]: + def post_create_order_tracking_signal_with_metadata( + self, + response: order_tracking_signals.OrderTrackingSignal, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + order_tracking_signals.OrderTrackingSignal, + Sequence[Tuple[str, Union[str, bytes]]], + ]: """Post-rpc interceptor for create_order_tracking_signal Override in a subclass to read or manipulate the response or metadata after it @@ -134,7 +146,9 @@ class OrderTrackingSignalsServiceRestStub: _interceptor: OrderTrackingSignalsServiceRestInterceptor -class OrderTrackingSignalsServiceRestTransport(_BaseOrderTrackingSignalsServiceRestTransport): +class OrderTrackingSignalsServiceRestTransport( + _BaseOrderTrackingSignalsServiceRestTransport +): """REST backend synchronous transport for OrderTrackingSignalsService. Service to serve order tracking signals public API. @@ -146,20 +160,21 @@ class OrderTrackingSignalsServiceRestTransport(_BaseOrderTrackingSignalsServiceR It sends JSON representations of protocol buffers over HTTP/1.1 """ - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[Callable[[ - ], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - interceptor: Optional[OrderTrackingSignalsServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[OrderTrackingSignalsServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: @@ -202,18 +217,24 @@ def __init__(self, *, client_info=client_info, always_use_jwt_access=always_use_jwt_access, url_scheme=url_scheme, - api_audience=api_audience + api_audience=api_audience, ) self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) + self._credentials, default_host=self.DEFAULT_HOST + ) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or OrderTrackingSignalsServiceRestInterceptor() self._prep_wrapped_messages(client_info) - class _CreateOrderTrackingSignal(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal, OrderTrackingSignalsServiceRestStub): + class _CreateOrderTrackingSignal( + _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal, + OrderTrackingSignalsServiceRestStub, + ): def __hash__(self): - return hash("OrderTrackingSignalsServiceRestTransport.CreateOrderTrackingSignal") + return hash( + "OrderTrackingSignalsServiceRestTransport.CreateOrderTrackingSignal" + ) @staticmethod def _get_response( @@ -223,78 +244,94 @@ def _get_response( session, timeout, transcoded_request, - body=None): - - uri = transcoded_request['uri'] - method = transcoded_request['method'] + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(session, method)( "{host}{uri}".format(host=host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, - ) + ) return response - def __call__(self, - request: order_tracking_signals.CreateOrderTrackingSignalRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, Union[str, bytes]]]=(), - ) -> order_tracking_signals.OrderTrackingSignal: + def __call__( + self, + request: order_tracking_signals.CreateOrderTrackingSignalRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> order_tracking_signals.OrderTrackingSignal: r"""Call the create order tracking - signal method over HTTP. - - Args: - request (~.order_tracking_signals.CreateOrderTrackingSignalRequest): - The request object. Signals only can be created but not - updated. Businesses need to call this - API only when the order is completely - shipped. Creates new order signal. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be - sent along with the request as metadata. Normally, each value must be of type `str`, - but for metadata keys ending with the suffix `-bin`, the corresponding values must - be of type `bytes`. - - Returns: - ~.order_tracking_signals.OrderTrackingSignal: - Represents a business trade from - which signals are extracted, such as - shipping. + signal method over HTTP. + + Args: + request (~.order_tracking_signals.CreateOrderTrackingSignalRequest): + The request object. Signals only can be created but not + updated. Businesses need to call this + API only when the order is completely + shipped. Creates new order signal. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.order_tracking_signals.OrderTrackingSignal: + Represents a business trade from + which signals are extracted, such as + shipping. """ - http_options = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_http_options() + http_options = ( + _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_http_options() + ) - request, metadata = self._interceptor.pre_create_order_tracking_signal(request, metadata) - transcoded_request = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_transcoded_request(http_options, request) + request, metadata = self._interceptor.pre_create_order_tracking_signal( + request, metadata + ) + transcoded_request = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_transcoded_request( + http_options, request + ) - body = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_request_body_json(transcoded_request) + body = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_request_body_json( + transcoded_request + ) # Jsonify the query params - query_params = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_query_params_json(transcoded_request) - - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER - request_url = "{host}{uri}".format(host=self._host, uri=transcoded_request['uri']) - method = transcoded_request['method'] + query_params = _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] try: request_payload = type(request).to_json(request) except: request_payload = None http_request = { - "payload": request_payload, - "requestMethod": method, - "requestUrl": request_url, - "headers": dict(metadata), + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), } _LOGGER.debug( f"Sending request for google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient.CreateOrderTrackingSignal", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": "CreateOrderTrackingSignal", "httpRequest": http_request, @@ -303,7 +340,15 @@ def __call__(self, ) # Send the request - response = OrderTrackingSignalsServiceRestTransport._CreateOrderTrackingSignal._get_response(self._host, metadata, query_params, self._session, timeout, transcoded_request, body) + response = OrderTrackingSignalsServiceRestTransport._CreateOrderTrackingSignal._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -318,20 +363,26 @@ def __call__(self, resp = self._interceptor.post_create_order_tracking_signal(resp) response_metadata = [(k, str(v)) for k, v in response.headers.items()] - resp, _ = self._interceptor.post_create_order_tracking_signal_with_metadata(resp, response_metadata) - if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER + resp, _ = self._interceptor.post_create_order_tracking_signal_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER try: - response_payload = order_tracking_signals.OrderTrackingSignal.to_json(response) + response_payload = ( + order_tracking_signals.OrderTrackingSignal.to_json(response) + ) except: response_payload = None http_response = { - "payload": response_payload, - "headers": dict(response.headers), - "status": response.status_code, + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, } _LOGGER.debug( "Received response for google.shopping.merchant.ordertracking_v1.OrderTrackingSignalsServiceClient.create_order_tracking_signal", - extra = { + extra={ "serviceName": "google.shopping.merchant.ordertracking.v1.OrderTrackingSignalsService", "rpcName": "CreateOrderTrackingSignal", "metadata": http_response["headers"], @@ -341,12 +392,15 @@ def __call__(self, return resp @property - def create_order_tracking_signal(self) -> Callable[ - [order_tracking_signals.CreateOrderTrackingSignalRequest], - order_tracking_signals.OrderTrackingSignal]: + def create_order_tracking_signal( + self, + ) -> Callable[ + [order_tracking_signals.CreateOrderTrackingSignalRequest], + order_tracking_signals.OrderTrackingSignal, + ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._CreateOrderTrackingSignal(self._session, self._host, self._interceptor) # type: ignore + return self._CreateOrderTrackingSignal(self._session, self._host, self._interceptor) # type: ignore @property def kind(self) -> str: @@ -356,6 +410,4 @@ def close(self): self._session.close() -__all__=( - 'OrderTrackingSignalsServiceRestTransport', -) +__all__ = ("OrderTrackingSignalsServiceRestTransport",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py similarity index 67% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py index 9fbf716ff82e..fcf66d1a4525 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/services/order_tracking_signals_service/transports/rest_base.py @@ -14,20 +14,20 @@ # limitations under the License. # import json # type: ignore -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from .base import OrderTrackingSignalsServiceTransport, DEFAULT_CLIENT_INFO - import re from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals +from .base import DEFAULT_CLIENT_INFO, OrderTrackingSignalsServiceTransport + -class _BaseOrderTrackingSignalsServiceRestTransport(OrderTrackingSignalsServiceTransport): +class _BaseOrderTrackingSignalsServiceRestTransport( + OrderTrackingSignalsServiceTransport +): """Base REST backend transport for OrderTrackingSignalsService. Note: This class is not meant to be used directly. Use its sync and @@ -40,14 +40,16 @@ class _BaseOrderTrackingSignalsServiceRestTransport(OrderTrackingSignalsServiceT It sends JSON representations of protocol buffers over HTTP/1.1 """ - def __init__(self, *, - host: str = 'merchantapi.googleapis.com', - credentials: Optional[Any] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: host (Optional[str]): @@ -71,7 +73,9 @@ def __init__(self, *, # Run the base constructor maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER url_match_items = maybe_url_match.groupdict() @@ -82,33 +86,39 @@ def __init__(self, *, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience + api_audience=api_audience, ) class _BaseCreateOrderTrackingSignal: def __hash__(self): # pragma: NO COVER return NotImplementedError("__hash__ must be implemented.") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } @staticmethod def _get_http_options(): - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals', - 'body': 'order_tracking_signal', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals", + "body": "order_tracking_signal", + }, ] return http_options @staticmethod def _get_transcoded_request(http_options, request): - pb_request = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(request) + pb_request = order_tracking_signals.CreateOrderTrackingSignalRequest.pb( + request + ) transcoded_request = path_template.transcode(http_options, pb_request) return transcoded_request @@ -117,22 +127,26 @@ def _get_request_body_json(transcoded_request): # Jsonify the request body body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True + transcoded_request["body"], use_integers_for_enums=True ) return body + @staticmethod def _get_query_params_json(transcoded_request): - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(_BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_unset_required_fields(query_params)) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseOrderTrackingSignalsServiceRestTransport._BaseCreateOrderTrackingSignal._get_unset_required_fields( + query_params + ) + ) query_params["$alt"] = "json;enum-encoding=int" return query_params -__all__=( - '_BaseOrderTrackingSignalsServiceRestTransport', -) +__all__ = ("_BaseOrderTrackingSignalsServiceRestTransport",) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/__init__.py similarity index 91% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/__init__.py index d1e7569d2768..1929227e8b03 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/types/__init__.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/__init__.py @@ -19,6 +19,6 @@ ) __all__ = ( - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', + "CreateOrderTrackingSignalRequest", + "OrderTrackingSignal", ) diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py similarity index 96% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py rename to packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py index d5378e80ce35..616c73c3bf0a 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py +++ b/packages/google-shopping-merchant-ordertracking/google/shopping/merchant_ordertracking_v1/types/order_tracking_signals.py @@ -17,17 +17,15 @@ from typing import MutableMapping, MutableSequence -import proto # type: ignore - from google.shopping.type.types import types from google.type import datetime_pb2 # type: ignore - +import proto # type: ignore __protobuf__ = proto.module( - package='google.shopping.merchant.ordertracking.v1', + package="google.shopping.merchant.ordertracking.v1", manifest={ - 'CreateOrderTrackingSignalRequest', - 'OrderTrackingSignal', + "CreateOrderTrackingSignalRequest", + "OrderTrackingSignal", }, ) @@ -57,10 +55,10 @@ class CreateOrderTrackingSignalRequest(proto.Message): proto.STRING, number=2, ) - order_tracking_signal: 'OrderTrackingSignal' = proto.Field( + order_tracking_signal: "OrderTrackingSignal" = proto.Field( proto.MESSAGE, number=3, - message='OrderTrackingSignal', + message="OrderTrackingSignal", ) @@ -170,6 +168,7 @@ class ShippingInfo(proto.Message): (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin. """ + class ShippingState(proto.Enum): r"""The current status of the shipments. @@ -221,10 +220,10 @@ class ShippingState(proto.Enum): number=8, message=datetime_pb2.DateTime, ) - shipping_status: 'OrderTrackingSignal.ShippingInfo.ShippingState' = proto.Field( + shipping_status: "OrderTrackingSignal.ShippingInfo.ShippingState" = proto.Field( proto.ENUM, number=9, - enum='OrderTrackingSignal.ShippingInfo.ShippingState', + enum="OrderTrackingSignal.ShippingInfo.ShippingState", ) origin_postal_code: str = proto.Field( proto.STRING, @@ -351,7 +350,9 @@ class ShipmentLineItemMapping(proto.Message): number=4, message=LineItemDetails, ) - shipment_line_item_mapping: MutableSequence[ShipmentLineItemMapping] = proto.RepeatedField( + shipment_line_item_mapping: MutableSequence[ + ShipmentLineItemMapping + ] = proto.RepeatedField( proto.MESSAGE, number=5, message=ShipmentLineItemMapping, diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py b/packages/google-shopping-merchant-ordertracking/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py rename to packages/google-shopping-merchant-ordertracking/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_async.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py b/packages/google-shopping-merchant-ordertracking/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py rename to packages/google-shopping-merchant-ordertracking/samples/generated_samples/merchantapi_v1_generated_order_tracking_signals_service_create_order_tracking_signal_sync.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json b/packages/google-shopping-merchant-ordertracking/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json rename to packages/google-shopping-merchant-ordertracking/samples/generated_samples/snippet_metadata_google.shopping.merchant.ordertracking.v1.json diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py b/packages/google-shopping-merchant-ordertracking/scripts/fixup_merchant_ordertracking_v1_keywords.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/scripts/fixup_merchant_ordertracking_v1_keywords.py rename to packages/google-shopping-merchant-ordertracking/scripts/fixup_merchant_ordertracking_v1_keywords.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py b/packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1/__init__.py similarity index 100% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1beta/google/shopping/merchant_ordertracking_v1beta/services/__init__.py rename to packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1/__init__.py diff --git a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py b/packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py similarity index 63% rename from owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py rename to packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py index 474f047a0593..06b4ecbcd4ef 100644 --- a/owl-bot-staging/google-shopping-merchant-ordertracking/v1/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py +++ b/packages/google-shopping-merchant-ordertracking/tests/unit/gapic/merchant_ordertracking_v1/test_order_tracking_signals_service.py @@ -14,6 +14,7 @@ # limitations under the License. # import os + # try/except added for compatibility with python < 3.8 try: from unittest import mock @@ -21,47 +22,45 @@ except ImportError: # pragma: NO COVER import mock -import grpc -from grpc.experimental import aio -from collections.abc import Iterable, AsyncIterable -from google.protobuf import json_format +from collections.abc import AsyncIterable, Iterable import json import math -import pytest + from google.api_core import api_core_version -from proto.marshal.rules.dates import DurationRule, TimestampRule +from google.protobuf import json_format +import grpc +from grpc.experimental import aio from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response from requests.sessions import Session -from google.protobuf import json_format try: from google.auth.aio import credentials as ga_credentials_async + HAS_GOOGLE_AUTH_AIO = True -except ImportError: # pragma: NO COVER +except ImportError: # pragma: NO COVER HAS_GOOGLE_AUTH_AIO = False +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template from google.api_core import client_options from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template from google.api_core import retry as retries +import google.auth from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account from google.protobuf import duration_pb2 # type: ignore -from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import OrderTrackingSignalsServiceAsyncClient -from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import OrderTrackingSignalsServiceClient -from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import transports -from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals from google.shopping.type.types import types from google.type import datetime_pb2 # type: ignore -import google.auth - +from google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service import ( + OrderTrackingSignalsServiceAsyncClient, + OrderTrackingSignalsServiceClient, + transports, +) +from google.shopping.merchant_ordertracking_v1.types import order_tracking_signals CRED_INFO_JSON = { "credential_source": "/path/to/file", @@ -76,9 +75,11 @@ async def mock_async_gen(data, chunk_size=1): chunk = data[i : i + chunk_size] yield chunk.encode("utf-8") + def client_cert_source_callback(): return b"cert bytes", b"key bytes" + # TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. # See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. def async_anonymous_credentials(): @@ -86,17 +87,27 @@ def async_anonymous_credentials(): return ga_credentials_async.AnonymousCredentials() return ga_credentials.AnonymousCredentials() + # If default endpoint is localhost, then default mtls endpoint will be the same. # This method modifies the default endpoint so the client can produce a different # mtls endpoint for endpoint testing purposes. def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + # If default endpoint template is localhost, then default mtls endpoint will be the same. # This method modifies the default endpoint template so the client can produce a different # mtls endpoint for endpoint testing purposes. def modify_default_endpoint_template(client): - return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) def test__get_default_mtls_endpoint(): @@ -107,101 +118,253 @@ def test__get_default_mtls_endpoint(): non_googleapi = "api.example.com" assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(None) is None - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + assert ( + OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_default_mtls_endpoint( + sandbox_mtls_endpoint + ) + == sandbox_mtls_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + def test__read_environment_variables(): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (True, "auto", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + True, + "auto", + None, + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): with pytest.raises(ValueError) as excinfo: OrderTrackingSignalsServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "never", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "never", + None, + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "always", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "always", + None, + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", None) + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): with pytest.raises(MutualTLSChannelError) as excinfo: OrderTrackingSignalsServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): - assert OrderTrackingSignalsServiceClient._read_environment_variables() == (False, "auto", "foo.com") + assert OrderTrackingSignalsServiceClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + def test__get_client_cert_source(): mock_provided_cert_source = mock.Mock() mock_default_cert_source = mock.Mock() - assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, False) is None - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + assert ( + OrderTrackingSignalsServiceClient._get_client_cert_source(None, False) is None + ) + assert ( + OrderTrackingSignalsServiceClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + OrderTrackingSignalsServiceClient._get_client_cert_source( + mock_provided_cert_source, True + ) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + OrderTrackingSignalsServiceClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + OrderTrackingSignalsServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): - assert OrderTrackingSignalsServiceClient._get_client_cert_source(None, True) is mock_default_cert_source - assert OrderTrackingSignalsServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +@mock.patch.object( + OrderTrackingSignalsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceClient), +) +@mock.patch.object( + OrderTrackingSignalsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient), +) def test__get_api_endpoint(): api_override = "foo.com" mock_client_cert_source = mock.Mock() default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + default_endpoint = ( + OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) mock_universe = "bar.com" - mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) - assert OrderTrackingSignalsServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint - assert OrderTrackingSignalsServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, None, default_universe, "auto" + ) + == default_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, None, default_universe, "always" + ) + == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == OrderTrackingSignalsServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, None, mock_universe, "never" + ) + == mock_endpoint + ) + assert ( + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, None, default_universe, "never" + ) + == default_endpoint + ) with pytest.raises(MutualTLSChannelError) as excinfo: - OrderTrackingSignalsServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") - assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + OrderTrackingSignalsServiceClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) def test__get_universe_domain(): client_universe_domain = "foo.com" universe_domain_env = "bar.com" - assert OrderTrackingSignalsServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain - assert OrderTrackingSignalsServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env - assert OrderTrackingSignalsServiceClient._get_universe_domain(None, None) == OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + assert ( + OrderTrackingSignalsServiceClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + OrderTrackingSignalsServiceClient._get_universe_domain( + None, universe_domain_env + ) + == universe_domain_env + ) + assert ( + OrderTrackingSignalsServiceClient._get_universe_domain(None, None) + == OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE + ) with pytest.raises(ValueError) as excinfo: OrderTrackingSignalsServiceClient._get_universe_domain("", None) assert str(excinfo.value) == "Universe Domain cannot be an empty string." -@pytest.mark.parametrize("error_code,cred_info_json,show_cred_info", [ - (401, CRED_INFO_JSON, True), - (403, CRED_INFO_JSON, True), - (404, CRED_INFO_JSON, True), - (500, CRED_INFO_JSON, False), - (401, None, False), - (403, None, False), - (404, None, False), - (500, None, False) -]) + +@pytest.mark.parametrize( + "error_code,cred_info_json,show_cred_info", + [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False), + ], +) def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): cred = mock.Mock(["get_cred_info"]) cred.get_cred_info = mock.Mock(return_value=cred_info_json) @@ -217,7 +380,8 @@ def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_in else: assert error.details == ["foo"] -@pytest.mark.parametrize("error_code", [401,403,404,500]) + +@pytest.mark.parametrize("error_code", [401, 403, 404, 500]) def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): cred = mock.Mock([]) assert not hasattr(cred, "get_cred_info") @@ -230,14 +394,22 @@ def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): client._add_cred_info_for_auth_errors(error) assert error.details == [] -@pytest.mark.parametrize("client_class,transport_name", [ - (OrderTrackingSignalsServiceClient, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, "rest"), -]) -def test_order_tracking_signals_service_client_from_service_account_info(client_class, transport_name): + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), + ], +) +def test_order_tracking_signals_service_client_from_service_account_info( + client_class, transport_name +): creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: factory.return_value = creds info = {"valid": True} client = client_class.from_service_account_info(info, transport=transport_name) @@ -245,52 +417,70 @@ def test_order_tracking_signals_service_client_from_service_account_info(client_ assert isinstance(client, client_class) assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://merchantapi.googleapis.com' + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" ) -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -def test_order_tracking_signals_service_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), + (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.OrderTrackingSignalsServiceRestTransport, "rest"), + ], +) +def test_order_tracking_signals_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: creds = service_account.Credentials(None, None, None) transport = transport_class(credentials=creds, always_use_jwt_access=True) use_jwt.assert_called_once_with(True) - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: creds = service_account.Credentials(None, None, None) transport = transport_class(credentials=creds, always_use_jwt_access=False) use_jwt.assert_not_called() -@pytest.mark.parametrize("client_class,transport_name", [ - (OrderTrackingSignalsServiceClient, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, "rest"), -]) -def test_order_tracking_signals_service_client_from_service_account_file(client_class, transport_name): +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (OrderTrackingSignalsServiceClient, "grpc"), + (OrderTrackingSignalsServiceAsyncClient, "grpc_asyncio"), + (OrderTrackingSignalsServiceClient, "rest"), + ], +) +def test_order_tracking_signals_service_client_from_service_account_file( + client_class, transport_name +): creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) assert client.transport._credentials == creds assert isinstance(client, client_class) assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://merchantapi.googleapis.com' + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" ) @@ -306,30 +496,57 @@ def test_order_tracking_signals_service_client_get_transport_class(): assert transport == transports.OrderTrackingSignalsServiceGrpcTransport -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) -def test_order_tracking_signals_service_client_client_options(client_class, transport_class, transport_name): +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + OrderTrackingSignalsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceClient), +) +@mock.patch.object( + OrderTrackingSignalsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient), +) +def test_order_tracking_signals_service_client_client_options( + client_class, transport_class, transport_name +): # Check that if channel is provided we won't create a new one. - with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) + with mock.patch.object( + OrderTrackingSignalsServiceClient, "get_transport_class" + ) as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) client = client_class(transport=transport) gtc.assert_not_called() # Check that if channel is provided via str we will create a new one. - with mock.patch.object(OrderTrackingSignalsServiceClient, 'get_transport_class') as gtc: + with mock.patch.object( + OrderTrackingSignalsServiceClient, "get_transport_class" + ) as gtc: client = client_class(transport=transport_name) gtc.assert_called() # Check the case api_endpoint is provided. options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(transport=transport_name, client_options=options) patched.assert_called_once_with( @@ -347,13 +564,15 @@ def test_order_tracking_signals_service_client_client_options(client_class, tran # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is # "never". with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None, @@ -365,7 +584,7 @@ def test_order_tracking_signals_service_client_client_options(client_class, tran # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is # "always". with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(transport=transport_name) patched.assert_called_once_with( @@ -385,23 +604,33 @@ def test_order_tracking_signals_service_client_client_options(client_class, tran with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): with pytest.raises(MutualTLSChannelError) as excinfo: client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): with pytest.raises(ValueError) as excinfo: client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) # Check the case quota_project_id is provided options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id="octopus", @@ -410,48 +639,102 @@ def test_order_tracking_signals_service_client_client_options(client_class, tran api_audience=None, ) # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None, client_info=transports.base.DEFAULT_CLIENT_INFO, always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "true"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", "false"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "true"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + "true", + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + "false", + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceRestTransport, + "rest", + "true", + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + OrderTrackingSignalsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceClient), +) +@mock.patch.object( + OrderTrackingSignalsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient), +) @mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_order_tracking_signals_service_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): +def test_order_tracking_signals_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. # Check the case client_cert_source is provided. Whether client cert is used depends on # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) if use_client_cert_env == "false": expected_client_cert_source = None - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) else: expected_client_cert_source = client_cert_source_callback expected_host = client.DEFAULT_MTLS_ENDPOINT @@ -470,12 +753,22 @@ def test_order_tracking_signals_service_client_mtls_env_auto(client_class, trans # Check the case ADC client cert is provided. Whether client cert is used depends on # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): if use_client_cert_env == "false": - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) expected_client_cert_source = None else: expected_host = client.DEFAULT_MTLS_ENDPOINT @@ -496,15 +789,22 @@ def test_order_tracking_signals_service_client_mtls_env_auto(client_class, trans ) # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): patched.return_value = None client = client_class(transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None, @@ -514,19 +814,34 @@ def test_order_tracking_signals_service_client_mtls_env_auto(client_class, trans ) -@pytest.mark.parametrize("client_class", [ - OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OrderTrackingSignalsServiceAsyncClient)) -def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source(client_class): +@pytest.mark.parametrize( + "client_class", + [OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient], +) +@mock.patch.object( + OrderTrackingSignalsServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OrderTrackingSignalsServiceClient), +) +@mock.patch.object( + OrderTrackingSignalsServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(OrderTrackingSignalsServiceAsyncClient), +) +def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source( + client_class, +): mock_client_cert_source = mock.Mock() # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) assert api_endpoint == mock_api_endpoint assert cert_source == mock_client_cert_source @@ -534,8 +849,12 @@ def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): mock_client_cert_source = mock.Mock() mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) assert api_endpoint == mock_api_endpoint assert cert_source is None @@ -553,16 +872,28 @@ def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() assert api_endpoint == client_class.DEFAULT_ENDPOINT assert cert_source is None # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT assert cert_source == mock_client_cert_source @@ -572,34 +903,65 @@ def test_order_tracking_signals_service_client_get_mtls_endpoint_and_cert_source with pytest.raises(MutualTLSChannelError) as excinfo: client_class.get_mtls_endpoint_and_cert_source() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): with pytest.raises(ValueError) as excinfo: client_class.get_mtls_endpoint_and_cert_source() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + -@pytest.mark.parametrize("client_class", [ - OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient -]) -@mock.patch.object(OrderTrackingSignalsServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceClient)) -@mock.patch.object(OrderTrackingSignalsServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient)) +@pytest.mark.parametrize( + "client_class", + [OrderTrackingSignalsServiceClient, OrderTrackingSignalsServiceAsyncClient], +) +@mock.patch.object( + OrderTrackingSignalsServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceClient), +) +@mock.patch.object( + OrderTrackingSignalsServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(OrderTrackingSignalsServiceAsyncClient), +) def test_order_tracking_signals_service_client_client_api_endpoint(client_class): mock_client_cert_source = client_cert_source_callback api_override = "foo.com" default_universe = OrderTrackingSignalsServiceClient._DEFAULT_UNIVERSE - default_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + default_endpoint = ( + OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) mock_universe = "bar.com" - mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + mock_endpoint = OrderTrackingSignalsServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", # use ClientOptions.api_endpoint as the api endpoint regardless. with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) assert client.api_endpoint == api_override # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", @@ -622,11 +984,19 @@ def test_order_tracking_signals_service_client_client_api_endpoint(client_class) universe_exists = hasattr(options, "universe_domain") if universe_exists: options = client_options.ClientOptions(universe_domain=mock_universe) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) else: - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) - assert client.universe_domain == (mock_universe if universe_exists else default_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. @@ -634,27 +1004,48 @@ def test_order_tracking_signals_service_client_client_api_endpoint(client_class) if hasattr(options, "universe_domain"): delattr(options, "universe_domain") with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) assert client.api_endpoint == default_endpoint -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc"), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest"), -]) -def test_order_tracking_signals_service_client_client_options_scopes(client_class, transport_class, transport_name): +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceRestTransport, + "rest", + ), + ], +) +def test_order_tracking_signals_service_client_client_options_scopes( + client_class, transport_class, transport_name +): # Check the case scopes are provided. options = client_options.ClientOptions( scopes=["1", "2"], ) - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=["1", "2"], client_cert_source_for_mtls=None, quota_project_id=None, @@ -663,24 +1054,45 @@ def test_order_tracking_signals_service_client_client_options_scopes(client_clas api_audience=None, ) -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceRestTransport, "rest", None), -]) -def test_order_tracking_signals_service_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceRestTransport, + "rest", + None, + ), + ], +) +def test_order_tracking_signals_service_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) + options = client_options.ClientOptions(credentials_file="credentials.json") - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None, @@ -689,11 +1101,14 @@ def test_order_tracking_signals_service_client_client_options_credentials_file(c api_audience=None, ) + def test_order_tracking_signals_service_client_client_options_from_dict(): - with mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceGrpcTransport.__init__') as grpc_transport: + with mock.patch( + "google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceGrpcTransport.__init__" + ) as grpc_transport: grpc_transport.return_value = None client = OrderTrackingSignalsServiceClient( - client_options={'api_endpoint': 'squid.clam.whelk'} + client_options={"api_endpoint": "squid.clam.whelk"} ) grpc_transport.assert_called_once_with( credentials=None, @@ -708,23 +1123,38 @@ def test_order_tracking_signals_service_client_client_options_from_dict(): ) -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport, "grpc", grpc_helpers), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_order_tracking_signals_service_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_order_tracking_signals_service_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) + options = client_options.ClientOptions(credentials_file="credentials.json") - with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) patched.assert_called_once_with( credentials=None, credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None, @@ -751,9 +1181,7 @@ def test_order_tracking_signals_service_client_create_channel_credentials_file(c credentials=file_creds, credentials_file=None, quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), + default_scopes=("https://www.googleapis.com/auth/content",), scopes=None, default_host="merchantapi.googleapis.com", ssl_credentials=None, @@ -764,11 +1192,14 @@ def test_order_tracking_signals_service_client_create_channel_credentials_file(c ) -@pytest.mark.parametrize("request_type", [ - order_tracking_signals.CreateOrderTrackingSignalRequest, - dict, -]) -def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): +@pytest.mark.parametrize( + "request_type", + [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, + ], +) +def test_create_order_tracking_signal(request_type, transport: str = "grpc"): client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -780,15 +1211,15 @@ def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: # Designate an appropriate return value for the call. call.return_value = order_tracking_signals.OrderTrackingSignal( order_tracking_signal_id=2519, merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', + order_id="order_id_value", + delivery_postal_code="delivery_postal_code_value", + delivery_region_code="delivery_region_code_value", ) response = client.create_order_tracking_signal(request) @@ -802,9 +1233,9 @@ def test_create_order_tracking_signal(request_type, transport: str = 'grpc'): assert isinstance(response, order_tracking_signals.OrderTrackingSignal) assert response.order_tracking_signal_id == 2519 assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' + assert response.order_id == "order_id_value" + assert response.delivery_postal_code == "delivery_postal_code_value" + assert response.delivery_region_code == "delivery_region_code_value" def test_create_order_tracking_signal_non_empty_request_with_auto_populated_field(): @@ -812,30 +1243,33 @@ def test_create_order_tracking_signal_non_empty_request_with_auto_populated_fiel # automatically populated, according to AIP-4235, with non-empty requests. client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', + transport="grpc", ) # Populate all string fields in the request which are not UUID4 # since we want to check that UUID4 are populated automatically # if they meet the requirements of AIP 4235. request = order_tracking_signals.CreateOrderTrackingSignalRequest( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) client.create_order_tracking_signal(request=request) call.assert_called() _, args, _ = call.mock_calls[0] assert args[0] == order_tracking_signals.CreateOrderTrackingSignalRequest( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) + def test_create_order_tracking_signal_use_cached_wrapped_rpc(): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call @@ -850,12 +1284,19 @@ def test_create_order_tracking_signal_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + assert ( + client._transport.create_order_tracking_signal + in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_order_tracking_signal + ] = mock_rpc request = {} client.create_order_tracking_signal(request) @@ -868,8 +1309,11 @@ def test_create_order_tracking_signal_use_cached_wrapped_rpc(): assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 + @pytest.mark.asyncio -async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): +async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, # instead of constructing them on each call with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: @@ -883,12 +1327,17 @@ async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transpo wrapper_fn.reset_mock() # Ensure method has been cached - assert client._client._transport.create_order_tracking_signal in client._client._transport._wrapped_methods + assert ( + client._client._transport.create_order_tracking_signal + in client._client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.AsyncMock() mock_rpc.return_value = mock.Mock() - client._client._transport._wrapped_methods[client._client._transport.create_order_tracking_signal] = mock_rpc + client._client._transport._wrapped_methods[ + client._client._transport.create_order_tracking_signal + ] = mock_rpc request = {} await client.create_order_tracking_signal(request) @@ -902,8 +1351,12 @@ async def test_create_order_tracking_signal_async_use_cached_wrapped_rpc(transpo assert wrapper_fn.call_count == 0 assert mock_rpc.call_count == 2 + @pytest.mark.asyncio -async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio', request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): +async def test_create_order_tracking_signal_async( + transport: str = "grpc_asyncio", + request_type=order_tracking_signals.CreateOrderTrackingSignalRequest, +): client = OrderTrackingSignalsServiceAsyncClient( credentials=async_anonymous_credentials(), transport=transport, @@ -915,16 +1368,18 @@ async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - )) + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id="order_id_value", + delivery_postal_code="delivery_postal_code_value", + delivery_region_code="delivery_region_code_value", + ) + ) response = await client.create_order_tracking_signal(request) # Establish that the underlying gRPC stub method was called. @@ -937,15 +1392,16 @@ async def test_create_order_tracking_signal_async(transport: str = 'grpc_asyncio assert isinstance(response, order_tracking_signals.OrderTrackingSignal) assert response.order_tracking_signal_id == 2519 assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' + assert response.order_id == "order_id_value" + assert response.delivery_postal_code == "delivery_postal_code_value" + assert response.delivery_region_code == "delivery_region_code_value" @pytest.mark.asyncio async def test_create_order_tracking_signal_async_from_dict(): await test_create_order_tracking_signal_async(request_type=dict) + def test_create_order_tracking_signal_field_headers(): client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), @@ -955,12 +1411,12 @@ def test_create_order_tracking_signal_field_headers(): # a field header. Set these to a non-empty value. request = order_tracking_signals.CreateOrderTrackingSignalRequest() - request.parent = 'parent_value' + request.parent = "parent_value" # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: call.return_value = order_tracking_signals.OrderTrackingSignal() client.create_order_tracking_signal(request) @@ -972,9 +1428,9 @@ def test_create_order_tracking_signal_field_headers(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] assert ( - 'x-goog-request-params', - 'parent=parent_value', - ) in kw['metadata'] + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] @pytest.mark.asyncio @@ -987,13 +1443,15 @@ async def test_create_order_tracking_signal_field_headers_async(): # a field header. Set these to a non-empty value. request = order_tracking_signals.CreateOrderTrackingSignalRequest() - request.parent = 'parent_value' + request.parent = "parent_value" # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + order_tracking_signals.OrderTrackingSignal() + ) await client.create_order_tracking_signal(request) # Establish that the underlying gRPC stub method was called. @@ -1004,9 +1462,9 @@ async def test_create_order_tracking_signal_field_headers_async(): # Establish that the field header was sent. _, _, kw = call.mock_calls[0] assert ( - 'x-goog-request-params', - 'parent=parent_value', - ) in kw['metadata'] + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] def test_create_order_tracking_signal_flattened(): @@ -1016,15 +1474,15 @@ def test_create_order_tracking_signal_flattened(): # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: # Designate an appropriate return value for the call. call.return_value = order_tracking_signals.OrderTrackingSignal() # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. client.create_order_tracking_signal( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) # Establish that the underlying call was made with the expected @@ -1032,10 +1490,10 @@ def test_create_order_tracking_signal_flattened(): assert len(call.mock_calls) == 1 _, args, _ = call.mock_calls[0] arg = args[0].parent - mock_val = 'parent_value' + mock_val = "parent_value" assert arg == mock_val arg = args[0].order_tracking_signal_id - mock_val = 'order_tracking_signal_id_value' + mock_val = "order_tracking_signal_id_value" assert arg == mock_val @@ -1049,10 +1507,11 @@ def test_create_order_tracking_signal_flattened_error(): with pytest.raises(ValueError): client.create_order_tracking_signal( order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) + @pytest.mark.asyncio async def test_create_order_tracking_signal_flattened_async(): client = OrderTrackingSignalsServiceAsyncClient( @@ -1061,17 +1520,19 @@ async def test_create_order_tracking_signal_flattened_async(): # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: # Designate an appropriate return value for the call. call.return_value = order_tracking_signals.OrderTrackingSignal() - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal()) + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + order_tracking_signals.OrderTrackingSignal() + ) # Call the method with a truthy value for each flattened field, # using the keyword arguments to the method. response = await client.create_order_tracking_signal( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) # Establish that the underlying call was made with the expected @@ -1079,12 +1540,13 @@ async def test_create_order_tracking_signal_flattened_async(): assert len(call.mock_calls) _, args, _ = call.mock_calls[0] arg = args[0].parent - mock_val = 'parent_value' + mock_val = "parent_value" assert arg == mock_val arg = args[0].order_tracking_signal_id - mock_val = 'order_tracking_signal_id_value' + mock_val = "order_tracking_signal_id_value" assert arg == mock_val + @pytest.mark.asyncio async def test_create_order_tracking_signal_flattened_error_async(): client = OrderTrackingSignalsServiceAsyncClient( @@ -1096,8 +1558,8 @@ async def test_create_order_tracking_signal_flattened_error_async(): with pytest.raises(ValueError): await client.create_order_tracking_signal( order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) @@ -1115,12 +1577,19 @@ def test_create_order_tracking_signal_rest_use_cached_wrapped_rpc(): wrapper_fn.reset_mock() # Ensure method has been cached - assert client._transport.create_order_tracking_signal in client._transport._wrapped_methods + assert ( + client._transport.create_order_tracking_signal + in client._transport._wrapped_methods + ) # Replace cached wrapped function with mock mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_order_tracking_signal] = mock_rpc + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.create_order_tracking_signal + ] = mock_rpc request = {} client.create_order_tracking_signal(request) @@ -1135,59 +1604,64 @@ def test_create_order_tracking_signal_rest_use_cached_wrapped_rpc(): assert mock_rpc.call_count == 2 -def test_create_order_tracking_signal_rest_required_fields(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): +def test_create_order_tracking_signal_rest_required_fields( + request_type=order_tracking_signals.CreateOrderTrackingSignalRequest, +): transport_class = transports.OrderTrackingSignalsServiceRestTransport request_init = {} request_init["parent"] = "" request = request_type(**request_init) pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) # verify fields with default values are dropped - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_order_tracking_signal._get_unset_required_fields(jsonified_request) jsonified_request.update(unset_fields) # verify required fields with default values are now present - jsonified_request["parent"] = 'parent_value' + jsonified_request["parent"] = "parent_value" - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_order_tracking_signal._get_unset_required_fields(jsonified_request) + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).create_order_tracking_signal._get_unset_required_fields(jsonified_request) # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("order_tracking_signal_id", )) + assert not set(unset_fields) - set(("order_tracking_signal_id",)) jsonified_request.update(unset_fields) # verify required fields with non-default values are left alone assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' + assert jsonified_request["parent"] == "parent_value" client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), - transport='rest', + transport="rest", ) request = request_type(**request_init) # Designate an appropriate value for the returned response. return_value = order_tracking_signals.OrderTrackingSignal() # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: + with mock.patch.object(Session, "request") as req: # We need to mock transcode() because providing default values # for required fields will fail the real version if the http_options # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: + with mock.patch.object(path_template, "transcode") as transcode: # A uri without fields and an empty body will force all the # request fields to show up in the query_params. pb_request = request_type.pb(request) transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, } - transcode_result['body'] = pb_request + transcode_result["body"] = pb_request transcode.return_value = transcode_result response_value = Response() @@ -1197,24 +1671,32 @@ def test_create_order_tracking_signal_rest_required_fields(request_type=order_tr return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') + response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} response = client.create_order_tracking_signal(request) - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] assert expected_params == actual_params def test_create_order_tracking_signal_rest_unset_required_fields(): - transport = transports.OrderTrackingSignalsServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + transport = transports.OrderTrackingSignalsServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) unset_fields = transport.create_order_tracking_signal._get_unset_required_fields({}) - assert set(unset_fields) == (set(("orderTrackingSignalId", )) & set(("parent", "orderTrackingSignal", ))) + assert set(unset_fields) == ( + set(("orderTrackingSignalId",)) + & set( + ( + "parent", + "orderTrackingSignal", + ) + ) + ) def test_create_order_tracking_signal_rest_flattened(): @@ -1224,17 +1706,17 @@ def test_create_order_tracking_signal_rest_flattened(): ) # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: + with mock.patch.object(type(client.transport._session), "request") as req: # Designate an appropriate value for the returned response. return_value = order_tracking_signals.OrderTrackingSignal() # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'accounts/sample1'} + sample_request = {"parent": "accounts/sample1"} # get truthy value for each flattened field mock_args = dict( - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) mock_args.update(sample_request) @@ -1244,7 +1726,7 @@ def test_create_order_tracking_signal_rest_flattened(): # Convert return value to protobuf type return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') + response_value._content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} @@ -1254,10 +1736,14 @@ def test_create_order_tracking_signal_rest_flattened(): # request object values. assert len(req.mock_calls) == 1 _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals" % client.transport._host, args[1]) + assert path_template.validate( + "%s/ordertracking/v1/{parent=accounts/*}/orderTrackingSignals" + % client.transport._host, + args[1], + ) -def test_create_order_tracking_signal_rest_flattened_error(transport: str = 'rest'): +def test_create_order_tracking_signal_rest_flattened_error(transport: str = "rest"): client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), transport=transport, @@ -1268,8 +1754,8 @@ def test_create_order_tracking_signal_rest_flattened_error(transport: str = 'res with pytest.raises(ValueError): client.create_order_tracking_signal( order_tracking_signals.CreateOrderTrackingSignalRequest(), - parent='parent_value', - order_tracking_signal_id='order_tracking_signal_id_value', + parent="parent_value", + order_tracking_signal_id="order_tracking_signal_id_value", ) @@ -1311,8 +1797,7 @@ def test_credentials_transport_error(): options.api_key = "api_key" with pytest.raises(ValueError): client = OrderTrackingSignalsServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() + client_options=options, credentials=ga_credentials.AnonymousCredentials() ) # It is an error to provide scopes and a transport instance. @@ -1334,6 +1819,7 @@ def test_transport_instance(): client = OrderTrackingSignalsServiceClient(transport=transport) assert client.transport is transport + def test_transport_get_channel(): # A client may be instantiated with a custom transport instance. transport = transports.OrderTrackingSignalsServiceGrpcTransport( @@ -1348,18 +1834,23 @@ def test_transport_get_channel(): channel = transport.grpc_channel assert channel -@pytest.mark.parametrize("transport_class", [ - transports.OrderTrackingSignalsServiceGrpcTransport, - transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, - transports.OrderTrackingSignalsServiceRestTransport, -]) + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + transports.OrderTrackingSignalsServiceRestTransport, + ], +) def test_transport_adc(transport_class): # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: + with mock.patch.object(google.auth, "default") as adc: adc.return_value = (ga_credentials.AnonymousCredentials(), None) transport_class() adc.assert_called_once() + def test_transport_kind_grpc(): transport = OrderTrackingSignalsServiceClient.get_transport_class("grpc")( credentials=ga_credentials.AnonymousCredentials() @@ -1369,8 +1860,7 @@ def test_transport_kind_grpc(): def test_initialize_client_w_grpc(): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" ) assert client is not None @@ -1385,8 +1875,8 @@ def test_create_order_tracking_signal_empty_call_grpc(): # Mock the actual call, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: call.return_value = order_tracking_signals.OrderTrackingSignal() client.create_order_tracking_signal(request=None) @@ -1399,16 +1889,15 @@ def test_create_order_tracking_signal_empty_call_grpc(): def test_transport_kind_grpc_asyncio(): - transport = OrderTrackingSignalsServiceAsyncClient.get_transport_class("grpc_asyncio")( - credentials=async_anonymous_credentials() - ) + transport = OrderTrackingSignalsServiceAsyncClient.get_transport_class( + "grpc_asyncio" + )(credentials=async_anonymous_credentials()) assert transport.kind == "grpc_asyncio" def test_initialize_client_w_grpc_asyncio(): client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio" + credentials=async_anonymous_credentials(), transport="grpc_asyncio" ) assert client is not None @@ -1424,16 +1913,18 @@ async def test_create_order_tracking_signal_empty_call_grpc_asyncio(): # Mock the actual call, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', - )) + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + order_tracking_signals.OrderTrackingSignal( + order_tracking_signal_id=2519, + merchant_id=1150, + order_id="order_id_value", + delivery_postal_code="delivery_postal_code_value", + delivery_region_code="delivery_region_code_value", + ) + ) await client.create_order_tracking_signal(request=None) # Establish that the underlying stub method was called. @@ -1451,20 +1942,23 @@ def test_transport_kind_rest(): assert transport.kind == "rest" -def test_create_order_tracking_signal_rest_bad_request(request_type=order_tracking_signals.CreateOrderTrackingSignalRequest): +def test_create_order_tracking_signal_rest_bad_request( + request_type=order_tracking_signals.CreateOrderTrackingSignalRequest, +): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {'parent': 'accounts/sample1'} + request_init = {"parent": "accounts/sample1"} request = request_type(**request_init) # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): # Wrap the value into a proper Response obj response_value = mock.Mock() - json_return_value = '' + json_return_value = "" response_value.json = mock.Mock(return_value={}) response_value.status_code = 400 response_value.request = mock.Mock() @@ -1473,25 +1967,83 @@ def test_create_order_tracking_signal_rest_bad_request(request_type=order_tracki client.create_order_tracking_signal(request) -@pytest.mark.parametrize("request_type", [ - order_tracking_signals.CreateOrderTrackingSignalRequest, - dict, -]) +@pytest.mark.parametrize( + "request_type", + [ + order_tracking_signals.CreateOrderTrackingSignalRequest, + dict, + ], +) def test_create_order_tracking_signal_rest_call_success(request_type): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) # send a request that will satisfy transcoding - request_init = {'parent': 'accounts/sample1'} - request_init["order_tracking_signal"] = {'order_tracking_signal_id': 2519, 'merchant_id': 1150, 'order_created_time': {'year': 433, 'month': 550, 'day': 318, 'hours': 561, 'minutes': 773, 'seconds': 751, 'nanos': 543, 'utc_offset': {'seconds': 751, 'nanos': 543}, 'time_zone': {'id': 'id_value', 'version': 'version_value'}}, 'order_id': 'order_id_value', 'shipping_info': [{'shipment_id': 'shipment_id_value', 'tracking_id': 'tracking_id_value', 'carrier': 'carrier_value', 'carrier_service': 'carrier_service_value', 'shipped_time': {}, 'earliest_delivery_promise_time': {}, 'latest_delivery_promise_time': {}, 'actual_delivery_time': {}, 'shipping_status': 1, 'origin_postal_code': 'origin_postal_code_value', 'origin_region_code': 'origin_region_code_value'}], 'line_items': [{'line_item_id': 'line_item_id_value', 'product_id': 'product_id_value', 'gtins': ['gtins_value1', 'gtins_value2'], 'mpn': 'mpn_value', 'product_title': 'product_title_value', 'brand': 'brand_value', 'quantity': 895}], 'shipment_line_item_mapping': [{'shipment_id': 'shipment_id_value', 'line_item_id': 'line_item_id_value', 'quantity': 895}], 'customer_shipping_fee': {'amount_micros': 1408, 'currency_code': 'currency_code_value'}, 'delivery_postal_code': 'delivery_postal_code_value', 'delivery_region_code': 'delivery_region_code_value'} + request_init = {"parent": "accounts/sample1"} + request_init["order_tracking_signal"] = { + "order_tracking_signal_id": 2519, + "merchant_id": 1150, + "order_created_time": { + "year": 433, + "month": 550, + "day": 318, + "hours": 561, + "minutes": 773, + "seconds": 751, + "nanos": 543, + "utc_offset": {"seconds": 751, "nanos": 543}, + "time_zone": {"id": "id_value", "version": "version_value"}, + }, + "order_id": "order_id_value", + "shipping_info": [ + { + "shipment_id": "shipment_id_value", + "tracking_id": "tracking_id_value", + "carrier": "carrier_value", + "carrier_service": "carrier_service_value", + "shipped_time": {}, + "earliest_delivery_promise_time": {}, + "latest_delivery_promise_time": {}, + "actual_delivery_time": {}, + "shipping_status": 1, + "origin_postal_code": "origin_postal_code_value", + "origin_region_code": "origin_region_code_value", + } + ], + "line_items": [ + { + "line_item_id": "line_item_id_value", + "product_id": "product_id_value", + "gtins": ["gtins_value1", "gtins_value2"], + "mpn": "mpn_value", + "product_title": "product_title_value", + "brand": "brand_value", + "quantity": 895, + } + ], + "shipment_line_item_mapping": [ + { + "shipment_id": "shipment_id_value", + "line_item_id": "line_item_id_value", + "quantity": 895, + } + ], + "customer_shipping_fee": { + "amount_micros": 1408, + "currency_code": "currency_code_value", + }, + "delivery_postal_code": "delivery_postal_code_value", + "delivery_region_code": "delivery_region_code_value", + } # The version of a generated dependency at test runtime may differ from the version used during generation. # Delete any fields which are not present in the current runtime dependency # See https://github.com/googleapis/gapic-generator-python/issues/1748 # Determine if the message type is proto-plus or protobuf - test_field = order_tracking_signals.CreateOrderTrackingSignalRequest.meta.fields["order_tracking_signal"] + test_field = order_tracking_signals.CreateOrderTrackingSignalRequest.meta.fields[ + "order_tracking_signal" + ] def get_message_fields(field): # Given a field which is a message (composite type), return a list with @@ -1505,7 +2057,7 @@ def get_message_fields(field): if is_field_type_proto_plus_type: message_fields = field.message.meta.fields.values() # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER + else: # pragma: NO COVER message_fields = field.message.DESCRIPTOR.fields return message_fields @@ -1519,7 +2071,9 @@ def get_message_fields(field): # For each item in the sample request, create a list of sub fields which are not present at runtime # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["order_tracking_signal"].items(): # pragma: NO COVER + for field, value in request_init[ + "order_tracking_signal" + ].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -1534,12 +2088,16 @@ def get_message_fields(field): for subfield in result.keys(): if (field, subfield) not in runtime_nested_fields: subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } ) # Remove fields from the sample request which are not present in the runtime version of the dependency # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER field = subfield_to_delete.get("field") field_repeated = subfield_to_delete.get("is_repeated") subfield = subfield_to_delete.get("subfield") @@ -1552,14 +2110,14 @@ def get_message_fields(field): request = request_type(**request_init) # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: + with mock.patch.object(type(client.transport._session), "request") as req: # Designate an appropriate value for the returned response. return_value = order_tracking_signals.OrderTrackingSignal( - order_tracking_signal_id=2519, - merchant_id=1150, - order_id='order_id_value', - delivery_postal_code='delivery_postal_code_value', - delivery_region_code='delivery_region_code_value', + order_tracking_signal_id=2519, + merchant_id=1150, + order_id="order_id_value", + delivery_postal_code="delivery_postal_code_value", + delivery_region_code="delivery_region_code_value", ) # Wrap the value into a proper Response obj @@ -1569,7 +2127,7 @@ def get_message_fields(field): # Convert return value to protobuf type return_value = order_tracking_signals.OrderTrackingSignal.pb(return_value) json_return_value = json_format.MessageToJson(return_value) - response_value.content = json_return_value.encode('UTF-8') + response_value.content = json_return_value.encode("UTF-8") req.return_value = response_value req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} response = client.create_order_tracking_signal(request) @@ -1578,28 +2136,41 @@ def get_message_fields(field): assert isinstance(response, order_tracking_signals.OrderTrackingSignal) assert response.order_tracking_signal_id == 2519 assert response.merchant_id == 1150 - assert response.order_id == 'order_id_value' - assert response.delivery_postal_code == 'delivery_postal_code_value' - assert response.delivery_region_code == 'delivery_region_code_value' + assert response.order_id == "order_id_value" + assert response.delivery_postal_code == "delivery_postal_code_value" + assert response.delivery_region_code == "delivery_region_code_value" @pytest.mark.parametrize("null_interceptor", [True, False]) def test_create_order_tracking_signal_rest_interceptors(null_interceptor): transport = transports.OrderTrackingSignalsServiceRestTransport( credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OrderTrackingSignalsServiceRestInterceptor(), - ) + interceptor=None + if null_interceptor + else transports.OrderTrackingSignalsServiceRestInterceptor(), + ) client = OrderTrackingSignalsServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal") as post, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "post_create_order_tracking_signal_with_metadata") as post_with_metadata, \ - mock.patch.object(transports.OrderTrackingSignalsServiceRestInterceptor, "pre_create_order_tracking_signal") as pre: + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.OrderTrackingSignalsServiceRestInterceptor, + "post_create_order_tracking_signal", + ) as post, mock.patch.object( + transports.OrderTrackingSignalsServiceRestInterceptor, + "post_create_order_tracking_signal_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.OrderTrackingSignalsServiceRestInterceptor, + "pre_create_order_tracking_signal", + ) as pre: pre.assert_not_called() post.assert_not_called() post_with_metadata.assert_not_called() - pb_message = order_tracking_signals.CreateOrderTrackingSignalRequest.pb(order_tracking_signals.CreateOrderTrackingSignalRequest()) + pb_message = order_tracking_signals.CreateOrderTrackingSignalRequest.pb( + order_tracking_signals.CreateOrderTrackingSignalRequest() + ) transcode.return_value = { "method": "post", "uri": "my_uri", @@ -1610,28 +2181,39 @@ def test_create_order_tracking_signal_rest_interceptors(null_interceptor): req.return_value = mock.Mock() req.return_value.status_code = 200 req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} - return_value = order_tracking_signals.OrderTrackingSignal.to_json(order_tracking_signals.OrderTrackingSignal()) + return_value = order_tracking_signals.OrderTrackingSignal.to_json( + order_tracking_signals.OrderTrackingSignal() + ) req.return_value.content = return_value request = order_tracking_signals.CreateOrderTrackingSignalRequest() - metadata =[ + metadata = [ ("key", "val"), ("cephalopod", "squid"), ] pre.return_value = request, metadata post.return_value = order_tracking_signals.OrderTrackingSignal() - post_with_metadata.return_value = order_tracking_signals.OrderTrackingSignal(), metadata + post_with_metadata.return_value = ( + order_tracking_signals.OrderTrackingSignal(), + metadata, + ) - client.create_order_tracking_signal(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + client.create_order_tracking_signal( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) pre.assert_called_once() post.assert_called_once() post_with_metadata.assert_called_once() + def test_initialize_client_w_rest(): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) assert client is not None @@ -1646,8 +2228,8 @@ def test_create_order_tracking_signal_empty_call_rest(): # Mock the actual call, and fake the request. with mock.patch.object( - type(client.transport.create_order_tracking_signal), - '__call__') as call: + type(client.transport.create_order_tracking_signal), "__call__" + ) as call: client.create_order_tracking_signal(request=None) # Establish that the underlying stub method was called. @@ -1668,18 +2250,21 @@ def test_transport_grpc_default(): transports.OrderTrackingSignalsServiceGrpcTransport, ) + def test_order_tracking_signals_service_base_transport_error(): # Passing both a credentials object and credentials_file should raise an error with pytest.raises(core_exceptions.DuplicateCredentialArgs): transport = transports.OrderTrackingSignalsServiceTransport( credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" + credentials_file="credentials.json", ) def test_order_tracking_signals_service_base_transport(): # Instantiate the base transport. - with mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport.__init__') as Transport: + with mock.patch( + "google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport.__init__" + ) as Transport: Transport.return_value = None transport = transports.OrderTrackingSignalsServiceTransport( credentials=ga_credentials.AnonymousCredentials(), @@ -1687,9 +2272,7 @@ def test_order_tracking_signals_service_base_transport(): # Every method on the transport should just blindly # raise NotImplementedError. - methods = ( - 'create_order_tracking_signal', - ) + methods = ("create_order_tracking_signal",) for method in methods: with pytest.raises(NotImplementedError): getattr(transport, method)(request=object()) @@ -1699,7 +2282,7 @@ def test_order_tracking_signals_service_base_transport(): # Catch all for all remaining methods and properties remainder = [ - 'kind', + "kind", ] for r in remainder: with pytest.raises(NotImplementedError): @@ -1708,25 +2291,30 @@ def test_order_tracking_signals_service_base_transport(): def test_order_tracking_signals_service_base_transport_with_credentials_file(): # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages" + ) as Transport: Transport.return_value = None load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) transport = transports.OrderTrackingSignalsServiceTransport( credentials_file="credentials.json", quota_project_id="octopus", ) - load_creds.assert_called_once_with("credentials.json", + load_creds.assert_called_once_with( + "credentials.json", scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), + default_scopes=("https://www.googleapis.com/auth/content",), quota_project_id="octopus", ) def test_order_tracking_signals_service_base_transport_with_adc(): # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages') as Transport: + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.shopping.merchant_ordertracking_v1.services.order_tracking_signals_service.transports.OrderTrackingSignalsServiceTransport._prep_wrapped_messages" + ) as Transport: Transport.return_value = None adc.return_value = (ga_credentials.AnonymousCredentials(), None) transport = transports.OrderTrackingSignalsServiceTransport() @@ -1735,14 +2323,12 @@ def test_order_tracking_signals_service_base_transport_with_adc(): def test_order_tracking_signals_service_auth_adc(): # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: + with mock.patch.object(google.auth, "default", autospec=True) as adc: adc.return_value = (ga_credentials.AnonymousCredentials(), None) OrderTrackingSignalsServiceClient() adc.assert_called_once_with( scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/content', -), + default_scopes=("https://www.googleapis.com/auth/content",), quota_project_id=None, ) @@ -1757,12 +2343,12 @@ def test_order_tracking_signals_service_auth_adc(): def test_order_tracking_signals_service_transport_auth_adc(transport_class): # If credentials and host are not provided, the transport class should use # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: + with mock.patch.object(google.auth, "default", autospec=True) as adc: adc.return_value = (ga_credentials.AnonymousCredentials(), None) transport_class(quota_project_id="octopus", scopes=["1", "2"]) adc.assert_called_once_with( scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/content',), + default_scopes=("https://www.googleapis.com/auth/content",), quota_project_id="octopus", ) @@ -1775,49 +2361,53 @@ def test_order_tracking_signals_service_transport_auth_adc(transport_class): transports.OrderTrackingSignalsServiceRestTransport, ], ) -def test_order_tracking_signals_service_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] +def test_order_tracking_signals_service_transport_auth_gdch_credentials( + transport_class, +): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: + with mock.patch.object(google.auth, "default", autospec=True) as adc: gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) adc.return_value = (gdch_mock, None) transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) + gdch_mock.with_gdch_audience.assert_called_once_with(e) @pytest.mark.parametrize( "transport_class,grpc_helpers", [ (transports.OrderTrackingSignalsServiceGrpcTransport, grpc_helpers), - (transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, grpc_helpers_async) + ( + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + grpc_helpers_async, + ), ], ) -def test_order_tracking_signals_service_transport_create_channel(transport_class, grpc_helpers): +def test_order_tracking_signals_service_transport_create_channel( + transport_class, grpc_helpers +): # If credentials and host are not provided, the transport class should use # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( grpc_helpers, "create_channel", autospec=True ) as create_channel: creds = ga_credentials.AnonymousCredentials() adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) create_channel.assert_called_with( "merchantapi.googleapis.com:443", credentials=creds, credentials_file=None, quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/content', -), + default_scopes=("https://www.googleapis.com/auth/content",), scopes=["1", "2"], default_host="merchantapi.googleapis.com", ssl_credentials=None, @@ -1828,9 +2418,15 @@ def test_order_tracking_signals_service_transport_create_channel(transport_class ) -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ], +) def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mtls( - transport_class + transport_class, ): cred = ga_credentials.AnonymousCredentials() @@ -1840,7 +2436,7 @@ def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mt transport_class( host="squid.clam.whelk", credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds + ssl_channel_credentials=mock_ssl_channel_creds, ) mock_create_channel.assert_called_once_with( "squid.clam.whelk:443", @@ -1861,62 +2457,80 @@ def test_order_tracking_signals_service_grpc_transport_client_cert_source_for_mt with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: transport_class( credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback + client_cert_source_for_mtls=client_cert_source_callback, ) expected_cert, expected_key = client_cert_source_callback() mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key + certificate_chain=expected_cert, private_key=expected_key ) + def test_order_tracking_signals_service_http_transport_client_cert_source_for_mtls(): cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.OrderTrackingSignalsServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.OrderTrackingSignalsServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback ) mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) def test_order_tracking_signals_service_host_no_port(transport_name): client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com'), - transport=transport_name, + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com" + ), + transport=transport_name, ) assert client.transport._host == ( - 'merchantapi.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://merchantapi.googleapis.com' + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" ) -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) def test_order_tracking_signals_service_host_with_port(transport_name): client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='merchantapi.googleapis.com:8000'), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com:8000" + ), transport=transport_name, ) assert client.transport._host == ( - 'merchantapi.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://merchantapi.googleapis.com:8000' + "merchantapi.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com:8000" ) -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_order_tracking_signals_service_client_transport_session_collision(transport_name): + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_order_tracking_signals_service_client_transport_session_collision( + transport_name, +): creds1 = ga_credentials.AnonymousCredentials() creds2 = ga_credentials.AnonymousCredentials() client1 = OrderTrackingSignalsServiceClient( @@ -1930,8 +2544,10 @@ def test_order_tracking_signals_service_client_transport_session_collision(trans session1 = client1.transport.create_order_tracking_signal._session session2 = client2.transport.create_order_tracking_signal._session assert session1 != session2 + + def test_order_tracking_signals_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) # Check that channel is used if provided. transport = transports.OrderTrackingSignalsServiceGrpcTransport( @@ -1944,7 +2560,7 @@ def test_order_tracking_signals_service_grpc_transport_channel(): def test_order_tracking_signals_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) # Check that channel is used if provided. transport = transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport( @@ -1958,12 +2574,22 @@ def test_order_tracking_signals_service_grpc_asyncio_transport_channel(): # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are # removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ], +) def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_source( - transport_class + transport_class, ): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: mock_ssl_cred = mock.Mock() grpc_ssl_channel_cred.return_value = mock_ssl_cred @@ -1972,7 +2598,7 @@ def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_ cred = ga_credentials.AnonymousCredentials() with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: + with mock.patch.object(google.auth, "default") as adc: adc.return_value = (cred, None) transport = transport_class( host="squid.clam.whelk", @@ -2002,9 +2628,15 @@ def test_order_tracking_signals_service_transport_channel_mtls_with_client_cert_ # Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are # removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.OrderTrackingSignalsServiceGrpcTransport, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport]) +@pytest.mark.parametrize( + "transport_class", + [ + transports.OrderTrackingSignalsServiceGrpcTransport, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ], +) def test_order_tracking_signals_service_transport_channel_mtls_with_adc( - transport_class + transport_class, ): mock_ssl_cred = mock.Mock() with mock.patch.multiple( @@ -2012,7 +2644,9 @@ def test_order_tracking_signals_service_transport_channel_mtls_with_adc( __init__=mock.Mock(return_value=None), ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: mock_grpc_channel = mock.Mock() grpc_create_channel.return_value = mock_grpc_channel mock_cred = mock.Mock() @@ -2042,7 +2676,9 @@ def test_order_tracking_signals_service_transport_channel_mtls_with_adc( def test_account_path(): account = "squid" - expected = "accounts/{account}".format(account=account, ) + expected = "accounts/{account}".format( + account=account, + ) actual = OrderTrackingSignalsServiceClient.account_path(account) assert expected == actual @@ -2057,10 +2693,15 @@ def test_parse_account_path(): actual = OrderTrackingSignalsServiceClient.parse_account_path(path) assert expected == actual + def test_common_billing_account_path(): billing_account = "whelk" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = OrderTrackingSignalsServiceClient.common_billing_account_path(billing_account) + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = OrderTrackingSignalsServiceClient.common_billing_account_path( + billing_account + ) assert expected == actual @@ -2074,9 +2715,12 @@ def test_parse_common_billing_account_path(): actual = OrderTrackingSignalsServiceClient.parse_common_billing_account_path(path) assert expected == actual + def test_common_folder_path(): folder = "oyster" - expected = "folders/{folder}".format(folder=folder, ) + expected = "folders/{folder}".format( + folder=folder, + ) actual = OrderTrackingSignalsServiceClient.common_folder_path(folder) assert expected == actual @@ -2091,9 +2735,12 @@ def test_parse_common_folder_path(): actual = OrderTrackingSignalsServiceClient.parse_common_folder_path(path) assert expected == actual + def test_common_organization_path(): organization = "cuttlefish" - expected = "organizations/{organization}".format(organization=organization, ) + expected = "organizations/{organization}".format( + organization=organization, + ) actual = OrderTrackingSignalsServiceClient.common_organization_path(organization) assert expected == actual @@ -2108,9 +2755,12 @@ def test_parse_common_organization_path(): actual = OrderTrackingSignalsServiceClient.parse_common_organization_path(path) assert expected == actual + def test_common_project_path(): project = "winkle" - expected = "projects/{project}".format(project=project, ) + expected = "projects/{project}".format( + project=project, + ) actual = OrderTrackingSignalsServiceClient.common_project_path(project) assert expected == actual @@ -2125,10 +2775,14 @@ def test_parse_common_project_path(): actual = OrderTrackingSignalsServiceClient.parse_common_project_path(path) assert expected == actual + def test_common_location_path(): project = "scallop" location = "abalone" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) actual = OrderTrackingSignalsServiceClient.common_location_path(project, location) assert expected == actual @@ -2148,14 +2802,18 @@ def test_parse_common_location_path(): def test_client_with_default_client_info(): client_info = gapic_v1.client_info.ClientInfo() - with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + with mock.patch.object( + transports.OrderTrackingSignalsServiceTransport, "_prep_wrapped_messages" + ) as prep: client = OrderTrackingSignalsServiceClient( credentials=ga_credentials.AnonymousCredentials(), client_info=client_info, ) prep.assert_called_once_with(client_info) - with mock.patch.object(transports.OrderTrackingSignalsServiceTransport, '_prep_wrapped_messages') as prep: + with mock.patch.object( + transports.OrderTrackingSignalsServiceTransport, "_prep_wrapped_messages" + ) as prep: transport_class = OrderTrackingSignalsServiceClient.get_transport_class() transport = transport_class( credentials=ga_credentials.AnonymousCredentials(), @@ -2166,10 +2824,11 @@ def test_client_with_default_client_info(): def test_transport_close_grpc(): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc" + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" ) - with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: with client: close.assert_not_called() close.assert_called_once() @@ -2178,10 +2837,11 @@ def test_transport_close_grpc(): @pytest.mark.asyncio async def test_transport_close_grpc_asyncio(): client = OrderTrackingSignalsServiceAsyncClient( - credentials=async_anonymous_credentials(), - transport="grpc_asyncio" + credentials=async_anonymous_credentials(), transport="grpc_asyncio" ) - with mock.patch.object(type(getattr(client.transport, "_grpc_channel")), "close") as close: + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: async with client: close.assert_not_called() close.assert_called_once() @@ -2189,10 +2849,11 @@ async def test_transport_close_grpc_asyncio(): def test_transport_close_rest(): client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest" + credentials=ga_credentials.AnonymousCredentials(), transport="rest" ) - with mock.patch.object(type(getattr(client.transport, "_session")), "close") as close: + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: with client: close.assert_not_called() close.assert_called_once() @@ -2200,13 +2861,12 @@ def test_transport_close_rest(): def test_client_ctx(): transports = [ - 'rest', - 'grpc', + "rest", + "grpc", ] for transport in transports: client = OrderTrackingSignalsServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport + credentials=ga_credentials.AnonymousCredentials(), transport=transport ) # Test client calls underlying transport. with mock.patch.object(type(client.transport), "close") as close: @@ -2215,10 +2875,20 @@ def test_client_ctx(): pass close.assert_called() -@pytest.mark.parametrize("client_class,transport_class", [ - (OrderTrackingSignalsServiceClient, transports.OrderTrackingSignalsServiceGrpcTransport), - (OrderTrackingSignalsServiceAsyncClient, transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport), -]) + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + ( + OrderTrackingSignalsServiceClient, + transports.OrderTrackingSignalsServiceGrpcTransport, + ), + ( + OrderTrackingSignalsServiceAsyncClient, + transports.OrderTrackingSignalsServiceGrpcAsyncIOTransport, + ), + ], +) def test_api_key_credentials(client_class, transport_class): with mock.patch.object( google.auth._default, "get_api_key_credentials", create=True @@ -2233,7 +2903,9 @@ def test_api_key_credentials(client_class, transport_class): patched.assert_called_once_with( credentials=mock_cred, credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), scopes=None, client_cert_source_for_mtls=None, quota_project_id=None,