From 8783c7e613bc31dfa4bd9c00da940caddb566d57 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 17 Oct 2023 19:53:44 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20post-p?= =?UTF-8?q?rocessor?= 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 --- owl-bot-staging/v3/.coveragerc | 13 - owl-bot-staging/v3/.flake8 | 33 - owl-bot-staging/v3/MANIFEST.in | 2 - owl-bot-staging/v3/README.rst | 49 - owl-bot-staging/v3/docs/_static/custom.css | 3 - owl-bot-staging/v3/docs/conf.py | 376 - owl-bot-staging/v3/docs/index.rst | 7 - .../v3/docs/translate_v3/services.rst | 6 - .../docs/translate_v3/translation_service.rst | 10 - .../v3/docs/translate_v3/types.rst | 6 - .../v3/google/cloud/translate/__init__.py | 101 - .../google/cloud/translate/gapic_version.py | 16 - .../v3/google/cloud/translate/py.typed | 2 - .../v3/google/cloud/translate_v3/__init__.py | 102 - .../cloud/translate_v3/gapic_metadata.json | 178 - .../cloud/translate_v3/gapic_version.py | 16 - .../v3/google/cloud/translate_v3/py.typed | 2 - .../cloud/translate_v3/services/__init__.py | 15 - .../services/translation_service/__init__.py | 22 - .../translation_service/async_client.py | 1579 ----- .../services/translation_service/client.py | 1757 ----- .../services/translation_service/pagers.py | 139 - .../transports/__init__.py | 38 - .../translation_service/transports/base.py | 310 - .../translation_service/transports/grpc.py | 541 -- .../transports/grpc_asyncio.py | 540 -- .../translation_service/transports/rest.py | 1421 ---- .../cloud/translate_v3/types/__init__.py | 94 - .../translate_v3/types/translation_service.py | 2194 ------ owl-bot-staging/v3/mypy.ini | 3 - owl-bot-staging/v3/noxfile.py | 184 - ..._metadata_google.cloud.translation.v3.json | 1729 ----- ..._service_batch_translate_document_async.py | 66 - ...n_service_batch_translate_document_sync.py | 66 - ...tion_service_batch_translate_text_async.py | 66 - ...ation_service_batch_translate_text_sync.py | 66 - ...anslation_service_create_glossary_async.py | 60 - ...ranslation_service_create_glossary_sync.py | 60 - ...anslation_service_delete_glossary_async.py | 56 - ...ranslation_service_delete_glossary_sync.py | 56 - ...anslation_service_detect_language_async.py | 53 - ...ranslation_service_detect_language_sync.py | 53 - ..._translation_service_get_glossary_async.py | 52 - ...d_translation_service_get_glossary_sync.py | 52 - ...n_service_get_supported_languages_async.py | 52 - ...on_service_get_supported_languages_sync.py | 52 - ...anslation_service_list_glossaries_async.py | 53 - ...ranslation_service_list_glossaries_sync.py | 53 - ...lation_service_translate_document_async.py | 57 - ...slation_service_translate_document_sync.py | 57 - ...ranslation_service_translate_text_async.py | 54 - ...translation_service_translate_text_sync.py | 54 - .../v3/scripts/fixup_translate_v3_keywords.py | 185 - owl-bot-staging/v3/setup.py | 90 - .../v3/testing/constraints-3.10.txt | 6 - .../v3/testing/constraints-3.11.txt | 6 - .../v3/testing/constraints-3.12.txt | 6 - .../v3/testing/constraints-3.7.txt | 9 - .../v3/testing/constraints-3.8.txt | 6 - .../v3/testing/constraints-3.9.txt | 6 - owl-bot-staging/v3/tests/__init__.py | 16 - owl-bot-staging/v3/tests/unit/__init__.py | 16 - .../v3/tests/unit/gapic/__init__.py | 16 - .../tests/unit/gapic/translate_v3/__init__.py | 16 - .../translate_v3/test_translation_service.py | 6204 ----------------- owl-bot-staging/v3beta1/.coveragerc | 13 - owl-bot-staging/v3beta1/.flake8 | 33 - owl-bot-staging/v3beta1/MANIFEST.in | 2 - owl-bot-staging/v3beta1/README.rst | 49 - .../v3beta1/docs/_static/custom.css | 3 - owl-bot-staging/v3beta1/docs/conf.py | 376 - owl-bot-staging/v3beta1/docs/index.rst | 7 - .../docs/translate_v3beta1/services.rst | 6 - .../translate_v3beta1/translation_service.rst | 10 - .../v3beta1/docs/translate_v3beta1/types.rst | 6 - .../google/cloud/translate/__init__.py | 101 - .../google/cloud/translate/gapic_version.py | 16 - .../v3beta1/google/cloud/translate/py.typed | 2 - .../cloud/translate_v3beta1/__init__.py | 102 - .../translate_v3beta1/gapic_metadata.json | 178 - .../cloud/translate_v3beta1/gapic_version.py | 16 - .../google/cloud/translate_v3beta1/py.typed | 2 - .../translate_v3beta1/services/__init__.py | 15 - .../services/translation_service/__init__.py | 22 - .../translation_service/async_client.py | 1494 ---- .../services/translation_service/client.py | 1673 ----- .../services/translation_service/pagers.py | 139 - .../transports/__init__.py | 38 - .../translation_service/transports/base.py | 310 - .../translation_service/transports/grpc.py | 541 -- .../transports/grpc_asyncio.py | 540 -- .../translation_service/transports/rest.py | 1421 ---- .../cloud/translate_v3beta1/types/__init__.py | 94 - .../types/translation_service.py | 2180 ------ owl-bot-staging/v3beta1/mypy.ini | 3 - owl-bot-staging/v3beta1/noxfile.py | 184 - ...data_google.cloud.translation.v3beta1.json | 1681 ----- ..._service_batch_translate_document_async.py | 66 - ...n_service_batch_translate_document_sync.py | 66 - ...tion_service_batch_translate_text_async.py | 66 - ...ation_service_batch_translate_text_sync.py | 66 - ...anslation_service_create_glossary_async.py | 60 - ...ranslation_service_create_glossary_sync.py | 60 - ...anslation_service_delete_glossary_async.py | 56 - ...ranslation_service_delete_glossary_sync.py | 56 - ...anslation_service_detect_language_async.py | 53 - ...ranslation_service_detect_language_sync.py | 53 - ..._translation_service_get_glossary_async.py | 52 - ...d_translation_service_get_glossary_sync.py | 52 - ...n_service_get_supported_languages_async.py | 52 - ...on_service_get_supported_languages_sync.py | 52 - ...anslation_service_list_glossaries_async.py | 53 - ...ranslation_service_list_glossaries_sync.py | 53 - ...lation_service_translate_document_async.py | 57 - ...slation_service_translate_document_sync.py | 57 - ...ranslation_service_translate_text_async.py | 54 - ...translation_service_translate_text_sync.py | 54 - .../fixup_translate_v3beta1_keywords.py | 185 - owl-bot-staging/v3beta1/setup.py | 90 - .../v3beta1/testing/constraints-3.10.txt | 6 - .../v3beta1/testing/constraints-3.11.txt | 6 - .../v3beta1/testing/constraints-3.12.txt | 6 - .../v3beta1/testing/constraints-3.7.txt | 9 - .../v3beta1/testing/constraints-3.8.txt | 6 - .../v3beta1/testing/constraints-3.9.txt | 6 - owl-bot-staging/v3beta1/tests/__init__.py | 16 - .../v3beta1/tests/unit/__init__.py | 16 - .../v3beta1/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/translate_v3beta1/__init__.py | 16 - .../test_translation_service.py | 6008 ---------------- .../translate_v3/test_translation_service.py | 9 +- .../test_translation_service.py | 9 +- 132 files changed, 12 insertions(+), 37995 deletions(-) delete mode 100644 owl-bot-staging/v3/.coveragerc delete mode 100644 owl-bot-staging/v3/.flake8 delete mode 100644 owl-bot-staging/v3/MANIFEST.in delete mode 100644 owl-bot-staging/v3/README.rst delete mode 100644 owl-bot-staging/v3/docs/_static/custom.css delete mode 100644 owl-bot-staging/v3/docs/conf.py delete mode 100644 owl-bot-staging/v3/docs/index.rst delete mode 100644 owl-bot-staging/v3/docs/translate_v3/services.rst delete mode 100644 owl-bot-staging/v3/docs/translate_v3/translation_service.rst delete mode 100644 owl-bot-staging/v3/docs/translate_v3/types.rst delete mode 100644 owl-bot-staging/v3/google/cloud/translate/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate/gapic_version.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate/py.typed delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/gapic_metadata.json delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/gapic_version.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/py.typed delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/async_client.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/client.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/pagers.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/base.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/rest.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/types/__init__.py delete mode 100644 owl-bot-staging/v3/google/cloud/translate_v3/types/translation_service.py delete mode 100644 owl-bot-staging/v3/mypy.ini delete mode 100644 owl-bot-staging/v3/noxfile.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/snippet_metadata_google.cloud.translation.v3.json delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_sync.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_async.py delete mode 100644 owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_sync.py delete mode 100644 owl-bot-staging/v3/scripts/fixup_translate_v3_keywords.py delete mode 100644 owl-bot-staging/v3/setup.py delete mode 100644 owl-bot-staging/v3/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v3/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v3/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v3/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v3/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v3/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/v3/tests/__init__.py delete mode 100644 owl-bot-staging/v3/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v3/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v3/tests/unit/gapic/translate_v3/__init__.py delete mode 100644 owl-bot-staging/v3/tests/unit/gapic/translate_v3/test_translation_service.py delete mode 100644 owl-bot-staging/v3beta1/.coveragerc delete mode 100644 owl-bot-staging/v3beta1/.flake8 delete mode 100644 owl-bot-staging/v3beta1/MANIFEST.in delete mode 100644 owl-bot-staging/v3beta1/README.rst delete mode 100644 owl-bot-staging/v3beta1/docs/_static/custom.css delete mode 100644 owl-bot-staging/v3beta1/docs/conf.py delete mode 100644 owl-bot-staging/v3beta1/docs/index.rst delete mode 100644 owl-bot-staging/v3beta1/docs/translate_v3beta1/services.rst delete mode 100644 owl-bot-staging/v3beta1/docs/translate_v3beta1/translation_service.rst delete mode 100644 owl-bot-staging/v3beta1/docs/translate_v3beta1/types.rst delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate/gapic_version.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate/py.typed delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_metadata.json delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_version.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/py.typed delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/async_client.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/client.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/pagers.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/base.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/rest.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/__init__.py delete mode 100644 owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/translation_service.py delete mode 100644 owl-bot-staging/v3beta1/mypy.ini delete mode 100644 owl-bot-staging/v3beta1/noxfile.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/snippet_metadata_google.cloud.translation.v3beta1.json delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_sync.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_async.py delete mode 100644 owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_sync.py delete mode 100644 owl-bot-staging/v3beta1/scripts/fixup_translate_v3beta1_keywords.py delete mode 100644 owl-bot-staging/v3beta1/setup.py delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v3beta1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/v3beta1/tests/__init__.py delete mode 100644 owl-bot-staging/v3beta1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v3beta1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/__init__.py delete mode 100644 owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/test_translation_service.py diff --git a/owl-bot-staging/v3/.coveragerc b/owl-bot-staging/v3/.coveragerc deleted file mode 100644 index 2dc20114..00000000 --- a/owl-bot-staging/v3/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/translate/__init__.py - google/cloud/translate/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/v3/.flake8 b/owl-bot-staging/v3/.flake8 deleted file mode 100644 index 29227d4c..00000000 --- a/owl-bot-staging/v3/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://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 by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/v3/MANIFEST.in b/owl-bot-staging/v3/MANIFEST.in deleted file mode 100644 index 8b3536ae..00000000 --- a/owl-bot-staging/v3/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/translate *.py -recursive-include google/cloud/translate_v3 *.py diff --git a/owl-bot-staging/v3/README.rst b/owl-bot-staging/v3/README.rst deleted file mode 100644 index d16a64f0..00000000 --- a/owl-bot-staging/v3/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Translate 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 Cloud Translate 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 diff --git a/owl-bot-staging/v3/docs/_static/custom.css b/owl-bot-staging/v3/docs/_static/custom.css deleted file mode 100644 index 06423be0..00000000 --- a/owl-bot-staging/v3/docs/_static/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -dl.field-list > dt { - min-width: 100px -} diff --git a/owl-bot-staging/v3/docs/conf.py b/owl-bot-staging/v3/docs/conf.py deleted file mode 100644 index ed053307..00000000 --- a/owl-bot-staging/v3/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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-cloud-translate 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("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# 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.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -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-cloud-translate" -copyright = u"2023, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# 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 = 'en' - -# 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"] - -# 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 Cloud Client Libraries for Python", - "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-cloud-translate-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-cloud-translate.tex", - u"google-cloud-translate 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-cloud-translate", - u"Google Cloud Translate 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-cloud-translate", - u"google-cloud-translate Documentation", - author, - "google-cloud-translate", - "GAPIC library for Google Cloud Translate API", - "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": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", 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/v3/docs/index.rst b/owl-bot-staging/v3/docs/index.rst deleted file mode 100644 index 0187d3e8..00000000 --- a/owl-bot-staging/v3/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - translate_v3/services - translate_v3/types diff --git a/owl-bot-staging/v3/docs/translate_v3/services.rst b/owl-bot-staging/v3/docs/translate_v3/services.rst deleted file mode 100644 index f457bf2c..00000000 --- a/owl-bot-staging/v3/docs/translate_v3/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Translate v3 API -========================================== -.. toctree:: - :maxdepth: 2 - - translation_service diff --git a/owl-bot-staging/v3/docs/translate_v3/translation_service.rst b/owl-bot-staging/v3/docs/translate_v3/translation_service.rst deleted file mode 100644 index e440fb5e..00000000 --- a/owl-bot-staging/v3/docs/translate_v3/translation_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -TranslationService ------------------------------------- - -.. automodule:: google.cloud.translate_v3.services.translation_service - :members: - :inherited-members: - -.. automodule:: google.cloud.translate_v3.services.translation_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v3/docs/translate_v3/types.rst b/owl-bot-staging/v3/docs/translate_v3/types.rst deleted file mode 100644 index b919f55c..00000000 --- a/owl-bot-staging/v3/docs/translate_v3/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Translate v3 API -======================================= - -.. automodule:: google.cloud.translate_v3.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v3/google/cloud/translate/__init__.py b/owl-bot-staging/v3/google/cloud/translate/__init__.py deleted file mode 100644 index 4fa6de08..00000000 --- a/owl-bot-staging/v3/google/cloud/translate/__init__.py +++ /dev/null @@ -1,101 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.translate import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.translate_v3.services.translation_service.client import TranslationServiceClient -from google.cloud.translate_v3.services.translation_service.async_client import TranslationServiceAsyncClient - -from google.cloud.translate_v3.types.translation_service import BatchDocumentInputConfig -from google.cloud.translate_v3.types.translation_service import BatchDocumentOutputConfig -from google.cloud.translate_v3.types.translation_service import BatchTranslateDocumentMetadata -from google.cloud.translate_v3.types.translation_service import BatchTranslateDocumentRequest -from google.cloud.translate_v3.types.translation_service import BatchTranslateDocumentResponse -from google.cloud.translate_v3.types.translation_service import BatchTranslateMetadata -from google.cloud.translate_v3.types.translation_service import BatchTranslateResponse -from google.cloud.translate_v3.types.translation_service import BatchTranslateTextRequest -from google.cloud.translate_v3.types.translation_service import CreateGlossaryMetadata -from google.cloud.translate_v3.types.translation_service import CreateGlossaryRequest -from google.cloud.translate_v3.types.translation_service import DeleteGlossaryMetadata -from google.cloud.translate_v3.types.translation_service import DeleteGlossaryRequest -from google.cloud.translate_v3.types.translation_service import DeleteGlossaryResponse -from google.cloud.translate_v3.types.translation_service import DetectedLanguage -from google.cloud.translate_v3.types.translation_service import DetectLanguageRequest -from google.cloud.translate_v3.types.translation_service import DetectLanguageResponse -from google.cloud.translate_v3.types.translation_service import DocumentInputConfig -from google.cloud.translate_v3.types.translation_service import DocumentOutputConfig -from google.cloud.translate_v3.types.translation_service import DocumentTranslation -from google.cloud.translate_v3.types.translation_service import GcsDestination -from google.cloud.translate_v3.types.translation_service import GcsSource -from google.cloud.translate_v3.types.translation_service import GetGlossaryRequest -from google.cloud.translate_v3.types.translation_service import GetSupportedLanguagesRequest -from google.cloud.translate_v3.types.translation_service import Glossary -from google.cloud.translate_v3.types.translation_service import GlossaryInputConfig -from google.cloud.translate_v3.types.translation_service import InputConfig -from google.cloud.translate_v3.types.translation_service import ListGlossariesRequest -from google.cloud.translate_v3.types.translation_service import ListGlossariesResponse -from google.cloud.translate_v3.types.translation_service import OutputConfig -from google.cloud.translate_v3.types.translation_service import SupportedLanguage -from google.cloud.translate_v3.types.translation_service import SupportedLanguages -from google.cloud.translate_v3.types.translation_service import TranslateDocumentRequest -from google.cloud.translate_v3.types.translation_service import TranslateDocumentResponse -from google.cloud.translate_v3.types.translation_service import TranslateTextGlossaryConfig -from google.cloud.translate_v3.types.translation_service import TranslateTextRequest -from google.cloud.translate_v3.types.translation_service import TranslateTextResponse -from google.cloud.translate_v3.types.translation_service import Translation - -__all__ = ('TranslationServiceClient', - 'TranslationServiceAsyncClient', - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentMetadata', - 'BatchTranslateDocumentRequest', - 'BatchTranslateDocumentResponse', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'BatchTranslateTextRequest', - 'CreateGlossaryMetadata', - 'CreateGlossaryRequest', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryRequest', - 'DeleteGlossaryResponse', - 'DetectedLanguage', - 'DetectLanguageRequest', - 'DetectLanguageResponse', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'DocumentTranslation', - 'GcsDestination', - 'GcsSource', - 'GetGlossaryRequest', - 'GetSupportedLanguagesRequest', - 'Glossary', - 'GlossaryInputConfig', - 'InputConfig', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'OutputConfig', - 'SupportedLanguage', - 'SupportedLanguages', - 'TranslateDocumentRequest', - 'TranslateDocumentResponse', - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', -) diff --git a/owl-bot-staging/v3/google/cloud/translate/gapic_version.py b/owl-bot-staging/v3/google/cloud/translate/gapic_version.py deleted file mode 100644 index 360a0d13..00000000 --- a/owl-bot-staging/v3/google/cloud/translate/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/google/cloud/translate/py.typed b/owl-bot-staging/v3/google/cloud/translate/py.typed deleted file mode 100644 index 39eb1d6c..00000000 --- a/owl-bot-staging/v3/google/cloud/translate/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-translate package uses inline types. diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/__init__.py b/owl-bot-staging/v3/google/cloud/translate_v3/__init__.py deleted file mode 100644 index 8e0c78cb..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/__init__.py +++ /dev/null @@ -1,102 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.translate_v3 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.translation_service import TranslationServiceClient -from .services.translation_service import TranslationServiceAsyncClient - -from .types.translation_service import BatchDocumentInputConfig -from .types.translation_service import BatchDocumentOutputConfig -from .types.translation_service import BatchTranslateDocumentMetadata -from .types.translation_service import BatchTranslateDocumentRequest -from .types.translation_service import BatchTranslateDocumentResponse -from .types.translation_service import BatchTranslateMetadata -from .types.translation_service import BatchTranslateResponse -from .types.translation_service import BatchTranslateTextRequest -from .types.translation_service import CreateGlossaryMetadata -from .types.translation_service import CreateGlossaryRequest -from .types.translation_service import DeleteGlossaryMetadata -from .types.translation_service import DeleteGlossaryRequest -from .types.translation_service import DeleteGlossaryResponse -from .types.translation_service import DetectedLanguage -from .types.translation_service import DetectLanguageRequest -from .types.translation_service import DetectLanguageResponse -from .types.translation_service import DocumentInputConfig -from .types.translation_service import DocumentOutputConfig -from .types.translation_service import DocumentTranslation -from .types.translation_service import GcsDestination -from .types.translation_service import GcsSource -from .types.translation_service import GetGlossaryRequest -from .types.translation_service import GetSupportedLanguagesRequest -from .types.translation_service import Glossary -from .types.translation_service import GlossaryInputConfig -from .types.translation_service import InputConfig -from .types.translation_service import ListGlossariesRequest -from .types.translation_service import ListGlossariesResponse -from .types.translation_service import OutputConfig -from .types.translation_service import SupportedLanguage -from .types.translation_service import SupportedLanguages -from .types.translation_service import TranslateDocumentRequest -from .types.translation_service import TranslateDocumentResponse -from .types.translation_service import TranslateTextGlossaryConfig -from .types.translation_service import TranslateTextRequest -from .types.translation_service import TranslateTextResponse -from .types.translation_service import Translation - -__all__ = ( - 'TranslationServiceAsyncClient', -'BatchDocumentInputConfig', -'BatchDocumentOutputConfig', -'BatchTranslateDocumentMetadata', -'BatchTranslateDocumentRequest', -'BatchTranslateDocumentResponse', -'BatchTranslateMetadata', -'BatchTranslateResponse', -'BatchTranslateTextRequest', -'CreateGlossaryMetadata', -'CreateGlossaryRequest', -'DeleteGlossaryMetadata', -'DeleteGlossaryRequest', -'DeleteGlossaryResponse', -'DetectLanguageRequest', -'DetectLanguageResponse', -'DetectedLanguage', -'DocumentInputConfig', -'DocumentOutputConfig', -'DocumentTranslation', -'GcsDestination', -'GcsSource', -'GetGlossaryRequest', -'GetSupportedLanguagesRequest', -'Glossary', -'GlossaryInputConfig', -'InputConfig', -'ListGlossariesRequest', -'ListGlossariesResponse', -'OutputConfig', -'SupportedLanguage', -'SupportedLanguages', -'TranslateDocumentRequest', -'TranslateDocumentResponse', -'TranslateTextGlossaryConfig', -'TranslateTextRequest', -'TranslateTextResponse', -'Translation', -'TranslationServiceClient', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/gapic_metadata.json b/owl-bot-staging/v3/google/cloud/translate_v3/gapic_metadata.json deleted file mode 100644 index b61ab661..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/gapic_metadata.json +++ /dev/null @@ -1,178 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.translate_v3", - "protoPackage": "google.cloud.translation.v3", - "schema": "1.0", - "services": { - "TranslationService": { - "clients": { - "grpc": { - "libraryClient": "TranslationServiceClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - }, - "grpc-async": { - "libraryClient": "TranslationServiceAsyncClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - }, - "rest": { - "libraryClient": "TranslationServiceClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/gapic_version.py b/owl-bot-staging/v3/google/cloud/translate_v3/gapic_version.py deleted file mode 100644 index 360a0d13..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/google/cloud/translate_v3/py.typed b/owl-bot-staging/v3/google/cloud/translate_v3/py.typed deleted file mode 100644 index 39eb1d6c..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-translate package uses inline types. diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/__init__.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/__init__.py deleted file mode 100644 index 89a37dc9..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/google/cloud/translate_v3/services/translation_service/__init__.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/__init__.py deleted file mode 100644 index 8717f41e..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslationServiceClient -from .async_client import TranslationServiceAsyncClient - -__all__ = ( - 'TranslationServiceClient', - 'TranslationServiceAsyncClient', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/async_client.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/async_client.py deleted file mode 100644 index 9e4f2de1..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/async_client.py +++ /dev/null @@ -1,1579 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.translate_v3 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 as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.translate_v3.services.translation_service import pagers -from google.cloud.translate_v3.types import translation_service -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .client import TranslationServiceClient - - -class TranslationServiceAsyncClient: - """Provides natural language translation operations.""" - - _client: TranslationServiceClient - - DEFAULT_ENDPOINT = TranslationServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = TranslationServiceClient.DEFAULT_MTLS_ENDPOINT - - glossary_path = staticmethod(TranslationServiceClient.glossary_path) - parse_glossary_path = staticmethod(TranslationServiceClient.parse_glossary_path) - common_billing_account_path = staticmethod(TranslationServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(TranslationServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(TranslationServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(TranslationServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(TranslationServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(TranslationServiceClient.parse_common_organization_path) - common_project_path = staticmethod(TranslationServiceClient.common_project_path) - parse_common_project_path = staticmethod(TranslationServiceClient.parse_common_project_path) - common_location_path = staticmethod(TranslationServiceClient.common_location_path) - parse_common_location_path = staticmethod(TranslationServiceClient.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: - TranslationServiceAsyncClient: The constructed client. - """ - return TranslationServiceClient.from_service_account_info.__func__(TranslationServiceAsyncClient, 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: - TranslationServiceAsyncClient: The constructed client. - """ - return TranslationServiceClient.from_service_account_file.__func__(TranslationServiceAsyncClient, 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 TranslationServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> TranslationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - TranslationServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(TranslationServiceClient).get_transport_class, type(TranslationServiceClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, TranslationServiceTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the translation 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 (Union[str, ~.TranslationServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "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). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS 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. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = TranslationServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def translate_text(self, - request: Optional[Union[translation_service.TranslateTextRequest, dict]] = None, - *, - parent: Optional[str] = None, - target_language_code: Optional[str] = None, - contents: Optional[MutableSequence[str]] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - source_language_code: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateTextResponse: - r"""Translates input text and returns translated text. - - .. 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.cloud import translate_v3 - - async def sample_translate_text(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = await client.translate_text(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.TranslateTextRequest, dict]]): - The request object. The request message for synchronous - translation. - parent (:class:`str`): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for requests using - AutoML models or custom glossaries. - - Models and glossaries must be within the same region - (have same location-id), otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_code (:class:`str`): - Required. The ISO-639 language code - to use for translation of the input - text, set to one of the language codes - listed in Language Support. - - This corresponds to the ``target_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contents (:class:`MutableSequence[str]`): - Required. The content of the input in - string format. We recommend the total - content be less than 30,000 codepoints. - The max length of this field is 1024. - Use BatchTranslateText for larger text. - - This corresponds to the ``contents`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (:class:`str`): - Optional. The ``model`` type requested for this - translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - For global (non-regionalized) requests, use - ``location-id`` ``global``. For example, - ``projects/{project-number-or-id}/locations/global/models/general/nmt``. - - If not provided, the default Google model (NMT) will be - used - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (:class:`str`): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (:class:`str`): - Optional. The ISO-639 language code - of the input text if known, for example, - "en-US" or "sr-Latn". Supported language - codes are listed in Language Support. If - the source language isn't specified, the - API attempts to identify the source - language automatically and returns the - source language within the response. - - This corresponds to the ``source_language_code`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.TranslateTextResponse: - - """ - # 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. - has_flattened_params = any([parent, target_language_code, contents, model, mime_type, source_language_code]) - 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.") - - request = translation_service.TranslateTextRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if target_language_code is not None: - request.target_language_code = target_language_code - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - if source_language_code is not None: - request.source_language_code = source_language_code - if contents: - request.contents.extend(contents) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.translate_text, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def detect_language(self, - request: Optional[Union[translation_service.DetectLanguageRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - content: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.DetectLanguageResponse: - r"""Detects the language of text within a request. - - .. 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.cloud import translate_v3 - - async def sample_detect_language(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = await client.detect_language(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.DetectLanguageRequest, dict]]): - The request object. The request message for language - detection. - parent (:class:`str`): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same - location-id) can be used. Otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (:class:`str`): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently - supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (:class:`str`): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - content (:class:`str`): - The content of the input stored as a - string. - - This corresponds to the ``content`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.DetectLanguageResponse: - The response message for language - detection. - - """ - # 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. - has_flattened_params = any([parent, model, mime_type, content]) - 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.") - - request = translation_service.DetectLanguageRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - if content is not None: - request.content = content - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.detect_language, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_supported_languages(self, - request: Optional[Union[translation_service.GetSupportedLanguagesRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - display_language_code: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.SupportedLanguages: - r"""Returns a list of supported languages for - translation. - - .. 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.cloud import translate_v3 - - async def sample_get_supported_languages(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = await client.get_supported_languages(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.GetSupportedLanguagesRequest, dict]]): - The request object. The request message for discovering - supported languages. - parent (:class:`str`): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same - location-id) can be used, otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (:class:`str`): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general - NMT model. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - display_language_code (:class:`str`): - Optional. The language to use to - return localized, human readable names - of supported languages. If missing, then - display names are not returned in a - response. - - This corresponds to the ``display_language_code`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.SupportedLanguages: - The response message for discovering - supported languages. - - """ - # 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. - has_flattened_params = any([parent, model, display_language_code]) - 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.") - - request = translation_service.GetSupportedLanguagesRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if display_language_code is not None: - request.display_language_code = display_language_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_supported_languages, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def translate_document(self, - request: Optional[Union[translation_service.TranslateDocumentRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateDocumentResponse: - r"""Translates documents in synchronous mode. - - .. 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.cloud import translate_v3 - - async def sample_translate_document(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - document_input_config = translate_v3.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = await client.translate_document(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.TranslateDocumentRequest, dict]]): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.TranslateDocumentResponse: - A translated document response - message. - - """ - # Create or coerce a protobuf request object. - request = translation_service.TranslateDocumentRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.translate_document, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def batch_translate_text(self, - request: Optional[Union[translation_service.BatchTranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - .. 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.cloud import translate_v3 - - async def sample_batch_translate_text(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.BatchTranslateTextRequest, dict]]): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.BatchTranslateResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one - sentence is translated successfully. - - """ - # Create or coerce a protobuf request object. - request = translation_service.BatchTranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.batch_translate_text, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.BatchTranslateResponse, - metadata_type=translation_service.BatchTranslateMetadata, - ) - - # Done; return the response. - return response - - async def batch_translate_document(self, - request: Optional[Union[translation_service.BatchTranslateDocumentRequest, dict]] = None, - *, - parent: Optional[str] = None, - source_language_code: Optional[str] = None, - target_language_codes: Optional[MutableSequence[str]] = None, - input_configs: Optional[MutableSequence[translation_service.BatchDocumentInputConfig]] = None, - output_config: Optional[translation_service.BatchDocumentOutputConfig] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - .. 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.cloud import translate_v3 - - async def sample_batch_translate_document(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.BatchTranslateDocumentRequest, dict]]): - The request object. The BatchTranslateDocument request. - parent (:class:`str`): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the - same region (have the same location-id) can be used, - otherwise an INVALID_ARGUMENT (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (:class:`str`): - Required. The ISO-639 language code of the input - document if known, for example, "en-US" or "sr-Latn". - Supported language codes are listed in `Language - Support `__. - - This corresponds to the ``source_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_codes (:class:`MutableSequence[str]`): - Required. The ISO-639 language code - to use for translation of the input - document. Specify up to 10 language - codes here. - - This corresponds to the ``target_language_codes`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - input_configs (:class:`MutableSequence[google.cloud.translate_v3.types.BatchDocumentInputConfig]`): - Required. Input configurations. - The total number of files matched should - be <= 100. The total content size to - translate should be <= 100M Unicode - codepoints. The files must use UTF-8 - encoding. - - This corresponds to the ``input_configs`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - output_config (:class:`google.cloud.translate_v3.types.BatchDocumentOutputConfig`): - Required. Output configuration. - If 2 input configs match to the same - file (that is, same input path), we - don't generate output for duplicate - inputs. - - This corresponds to the ``output_config`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.BatchTranslateDocumentResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least - one document is translated successfully. - - """ - # 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. - has_flattened_params = any([parent, source_language_code, target_language_codes, input_configs, output_config]) - 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.") - - request = translation_service.BatchTranslateDocumentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if source_language_code is not None: - request.source_language_code = source_language_code - if output_config is not None: - request.output_config = output_config - if target_language_codes: - request.target_language_codes.extend(target_language_codes) - if input_configs: - request.input_configs.extend(input_configs) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.batch_translate_document, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.BatchTranslateDocumentResponse, - metadata_type=translation_service.BatchTranslateDocumentMetadata, - ) - - # Done; return the response. - return response - - async def create_glossary(self, - request: Optional[Union[translation_service.CreateGlossaryRequest, dict]] = None, - *, - parent: Optional[str] = None, - glossary: Optional[translation_service.Glossary] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - .. 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.cloud import translate_v3 - - async def sample_create_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - glossary = translate_v3.Glossary() - glossary.name = "name_value" - - request = translate_v3.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.CreateGlossaryRequest, dict]]): - The request object. Request message for CreateGlossary. - parent (:class:`str`): - Required. The project name. - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - glossary (:class:`google.cloud.translate_v3.types.Glossary`): - Required. The glossary to create. - This corresponds to the ``glossary`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.translate_v3.types.Glossary` - Represents a glossary built from user-provided data. - - """ - # 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. - has_flattened_params = any([parent, glossary]) - 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.") - - request = translation_service.CreateGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if glossary is not None: - request.glossary = glossary - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_glossary, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.Glossary, - metadata_type=translation_service.CreateGlossaryMetadata, - ) - - # Done; return the response. - return response - - async def list_glossaries(self, - request: Optional[Union[translation_service.ListGlossariesRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGlossariesAsyncPager: - r"""Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - .. 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.cloud import translate_v3 - - async def sample_list_glossaries(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.ListGlossariesRequest, dict]]): - The request object. Request message for ListGlossaries. - parent (:class:`str`): - Required. The name of the project - from which to list all of the - glossaries. - - This corresponds to the ``parent`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.services.translation_service.pagers.ListGlossariesAsyncPager: - Response message for ListGlossaries. - - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # 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. - has_flattened_params = any([parent]) - 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.") - - request = translation_service.ListGlossariesRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_glossaries, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListGlossariesAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_glossary(self, - request: Optional[Union[translation_service.GetGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.Glossary: - r"""Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - .. 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.cloud import translate_v3 - - async def sample_get_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = await client.get_glossary(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.GetGlossaryRequest, dict]]): - The request object. Request message for GetGlossary. - name (:class:`str`): - Required. The name of the glossary to - retrieve. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.Glossary: - Represents a glossary built from - user-provided data. - - """ - # 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. - has_flattened_params = any([name]) - 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.") - - request = translation_service.GetGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_glossary(self, - request: Optional[Union[translation_service.DeleteGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - .. 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.cloud import translate_v3 - - async def sample_delete_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3.types.DeleteGlossaryRequest, dict]]): - The request object. Request message for DeleteGlossary. - name (:class:`str`): - Required. The name of the glossary to - delete. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.DeleteGlossaryResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - """ - # 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. - has_flattened_params = any([name]) - 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.") - - request = translation_service.DeleteGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.DeleteGlossaryResponse, - metadata_type=translation_service.DeleteGlossaryMetadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "TranslationServiceAsyncClient": - 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__) - - -__all__ = ( - "TranslationServiceAsyncClient", -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/client.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/client.py deleted file mode 100644 index 84c4f838..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/client.py +++ /dev/null @@ -1,1757 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.translate_v3 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 - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.translate_v3.services.translation_service import pagers -from google.cloud.translate_v3.types import translation_service -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import TranslationServiceGrpcTransport -from .transports.grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .transports.rest import TranslationServiceRestTransport - - -class TranslationServiceClientMeta(type): - """Metaclass for the TranslationService 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[TranslationServiceTransport]] - _transport_registry["grpc"] = TranslationServiceGrpcTransport - _transport_registry["grpc_asyncio"] = TranslationServiceGrpcAsyncIOTransport - _transport_registry["rest"] = TranslationServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[TranslationServiceTransport]: - """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 TranslationServiceClient(metaclass=TranslationServiceClientMeta): - """Provides natural language translation operations.""" - - @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") - - DEFAULT_ENDPOINT = "translate.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @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: - TranslationServiceClient: 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: - TranslationServiceClient: 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) -> TranslationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - TranslationServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def glossary_path(project: str,location: str,glossary: str,) -> str: - """Returns a fully-qualified glossary string.""" - return "projects/{project}/locations/{location}/glossaries/{glossary}".format(project=project, location=location, glossary=glossary, ) - - @staticmethod - def parse_glossary_path(path: str) -> Dict[str,str]: - """Parses a glossary path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/glossaries/(?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): - """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. - """ - 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 - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, TranslationServiceTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the translation 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 (Union[str, TranslationServiceTransport]): The - transport to use. 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. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "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). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS 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. - 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. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - client_options = cast(client_options_lib.ClientOptions, client_options) - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(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. - if isinstance(transport, TranslationServiceTransport): - # transport is a TranslationServiceTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - 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 = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def translate_text(self, - request: Optional[Union[translation_service.TranslateTextRequest, dict]] = None, - *, - parent: Optional[str] = None, - target_language_code: Optional[str] = None, - contents: Optional[MutableSequence[str]] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - source_language_code: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateTextResponse: - r"""Translates input text and returns translated text. - - .. 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.cloud import translate_v3 - - def sample_translate_text(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = client.translate_text(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.TranslateTextRequest, dict]): - The request object. The request message for synchronous - translation. - parent (str): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for requests using - AutoML models or custom glossaries. - - Models and glossaries must be within the same region - (have same location-id), otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_code (str): - Required. The ISO-639 language code - to use for translation of the input - text, set to one of the language codes - listed in Language Support. - - This corresponds to the ``target_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - contents (MutableSequence[str]): - Required. The content of the input in - string format. We recommend the total - content be less than 30,000 codepoints. - The max length of this field is 1024. - Use BatchTranslateText for larger text. - - This corresponds to the ``contents`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (str): - Optional. The ``model`` type requested for this - translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - For global (non-regionalized) requests, use - ``location-id`` ``global``. For example, - ``projects/{project-number-or-id}/locations/global/models/general/nmt``. - - If not provided, the default Google model (NMT) will be - used - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (str): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (str): - Optional. The ISO-639 language code - of the input text if known, for example, - "en-US" or "sr-Latn". Supported language - codes are listed in Language Support. If - the source language isn't specified, the - API attempts to identify the source - language automatically and returns the - source language within the response. - - This corresponds to the ``source_language_code`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.TranslateTextResponse: - - """ - # 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. - has_flattened_params = any([parent, target_language_code, contents, model, mime_type, source_language_code]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.TranslateTextRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.TranslateTextRequest): - request = translation_service.TranslateTextRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if target_language_code is not None: - request.target_language_code = target_language_code - if contents is not None: - request.contents = contents - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - if source_language_code is not None: - request.source_language_code = source_language_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.translate_text] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def detect_language(self, - request: Optional[Union[translation_service.DetectLanguageRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - content: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.DetectLanguageResponse: - r"""Detects the language of text within a request. - - .. 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.cloud import translate_v3 - - def sample_detect_language(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = client.detect_language(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.DetectLanguageRequest, dict]): - The request object. The request message for language - detection. - parent (str): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same - location-id) can be used. Otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (str): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently - supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (str): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - content (str): - The content of the input stored as a - string. - - This corresponds to the ``content`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.DetectLanguageResponse: - The response message for language - detection. - - """ - # 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. - has_flattened_params = any([parent, model, mime_type, content]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.DetectLanguageRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.DetectLanguageRequest): - request = translation_service.DetectLanguageRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - if content is not None: - request.content = content - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.detect_language] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_supported_languages(self, - request: Optional[Union[translation_service.GetSupportedLanguagesRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - display_language_code: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.SupportedLanguages: - r"""Returns a list of supported languages for - translation. - - .. 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.cloud import translate_v3 - - def sample_get_supported_languages(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = client.get_supported_languages(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.GetSupportedLanguagesRequest, dict]): - The request object. The request message for discovering - supported languages. - parent (str): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same - location-id) can be used, otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (str): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general - NMT model. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - display_language_code (str): - Optional. The language to use to - return localized, human readable names - of supported languages. If missing, then - display names are not returned in a - response. - - This corresponds to the ``display_language_code`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.SupportedLanguages: - The response message for discovering - supported languages. - - """ - # 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. - has_flattened_params = any([parent, model, display_language_code]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.GetSupportedLanguagesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.GetSupportedLanguagesRequest): - request = translation_service.GetSupportedLanguagesRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if display_language_code is not None: - request.display_language_code = display_language_code - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_supported_languages] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def translate_document(self, - request: Optional[Union[translation_service.TranslateDocumentRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateDocumentResponse: - r"""Translates documents in synchronous mode. - - .. 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.cloud import translate_v3 - - def sample_translate_document(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - document_input_config = translate_v3.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = client.translate_document(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.TranslateDocumentRequest, dict]): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.TranslateDocumentResponse: - A translated document response - message. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.TranslateDocumentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.TranslateDocumentRequest): - request = translation_service.TranslateDocumentRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.translate_document] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def batch_translate_text(self, - request: Optional[Union[translation_service.BatchTranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - .. 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.cloud import translate_v3 - - def sample_batch_translate_text(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.BatchTranslateTextRequest, dict]): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.BatchTranslateResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one - sentence is translated successfully. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.BatchTranslateTextRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.BatchTranslateTextRequest): - request = translation_service.BatchTranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.batch_translate_text] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.BatchTranslateResponse, - metadata_type=translation_service.BatchTranslateMetadata, - ) - - # Done; return the response. - return response - - def batch_translate_document(self, - request: Optional[Union[translation_service.BatchTranslateDocumentRequest, dict]] = None, - *, - parent: Optional[str] = None, - source_language_code: Optional[str] = None, - target_language_codes: Optional[MutableSequence[str]] = None, - input_configs: Optional[MutableSequence[translation_service.BatchDocumentInputConfig]] = None, - output_config: Optional[translation_service.BatchDocumentOutputConfig] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - .. 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.cloud import translate_v3 - - def sample_batch_translate_document(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.BatchTranslateDocumentRequest, dict]): - The request object. The BatchTranslateDocument request. - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the - same region (have the same location-id) can be used, - otherwise an INVALID_ARGUMENT (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (str): - Required. The ISO-639 language code of the input - document if known, for example, "en-US" or "sr-Latn". - Supported language codes are listed in `Language - Support `__. - - This corresponds to the ``source_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_codes (MutableSequence[str]): - Required. The ISO-639 language code - to use for translation of the input - document. Specify up to 10 language - codes here. - - This corresponds to the ``target_language_codes`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - input_configs (MutableSequence[google.cloud.translate_v3.types.BatchDocumentInputConfig]): - Required. Input configurations. - The total number of files matched should - be <= 100. The total content size to - translate should be <= 100M Unicode - codepoints. The files must use UTF-8 - encoding. - - This corresponds to the ``input_configs`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - output_config (google.cloud.translate_v3.types.BatchDocumentOutputConfig): - Required. Output configuration. - If 2 input configs match to the same - file (that is, same input path), we - don't generate output for duplicate - inputs. - - This corresponds to the ``output_config`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.BatchTranslateDocumentResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least - one document is translated successfully. - - """ - # 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. - has_flattened_params = any([parent, source_language_code, target_language_codes, input_configs, output_config]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.BatchTranslateDocumentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.BatchTranslateDocumentRequest): - request = translation_service.BatchTranslateDocumentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if source_language_code is not None: - request.source_language_code = source_language_code - if target_language_codes is not None: - request.target_language_codes = target_language_codes - if input_configs is not None: - request.input_configs = input_configs - if output_config is not None: - request.output_config = output_config - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.batch_translate_document] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.BatchTranslateDocumentResponse, - metadata_type=translation_service.BatchTranslateDocumentMetadata, - ) - - # Done; return the response. - return response - - def create_glossary(self, - request: Optional[Union[translation_service.CreateGlossaryRequest, dict]] = None, - *, - parent: Optional[str] = None, - glossary: Optional[translation_service.Glossary] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - .. 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.cloud import translate_v3 - - def sample_create_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - glossary = translate_v3.Glossary() - glossary.name = "name_value" - - request = translate_v3.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.CreateGlossaryRequest, dict]): - The request object. Request message for CreateGlossary. - parent (str): - Required. The project name. - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - glossary (google.cloud.translate_v3.types.Glossary): - Required. The glossary to create. - This corresponds to the ``glossary`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.translate_v3.types.Glossary` - Represents a glossary built from user-provided data. - - """ - # 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. - has_flattened_params = any([parent, glossary]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.CreateGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.CreateGlossaryRequest): - request = translation_service.CreateGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if glossary is not None: - request.glossary = glossary - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_glossary] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.Glossary, - metadata_type=translation_service.CreateGlossaryMetadata, - ) - - # Done; return the response. - return response - - def list_glossaries(self, - request: Optional[Union[translation_service.ListGlossariesRequest, dict]] = None, - *, - parent: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGlossariesPager: - r"""Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - .. 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.cloud import translate_v3 - - def sample_list_glossaries(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.ListGlossariesRequest, dict]): - The request object. Request message for ListGlossaries. - parent (str): - Required. The name of the project - from which to list all of the - glossaries. - - This corresponds to the ``parent`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.services.translation_service.pagers.ListGlossariesPager: - Response message for ListGlossaries. - - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # 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. - has_flattened_params = any([parent]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.ListGlossariesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.ListGlossariesRequest): - request = translation_service.ListGlossariesRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_glossaries] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListGlossariesPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_glossary(self, - request: Optional[Union[translation_service.GetGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.Glossary: - r"""Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - .. 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.cloud import translate_v3 - - def sample_get_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = client.get_glossary(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.GetGlossaryRequest, dict]): - The request object. Request message for GetGlossary. - name (str): - Required. The name of the glossary to - retrieve. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3.types.Glossary: - Represents a glossary built from - user-provided data. - - """ - # 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. - has_flattened_params = any([name]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.GetGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.GetGlossaryRequest): - request = translation_service.GetGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_glossary] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_glossary(self, - request: Optional[Union[translation_service.DeleteGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - .. 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.cloud import translate_v3 - - def sample_delete_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3.types.DeleteGlossaryRequest, dict]): - The request object. Request message for DeleteGlossary. - name (str): - Required. The name of the glossary to - delete. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3.types.DeleteGlossaryResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - """ - # 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. - has_flattened_params = any([name]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.DeleteGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.DeleteGlossaryRequest): - request = translation_service.DeleteGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_glossary] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.DeleteGlossaryResponse, - metadata_type=translation_service.DeleteGlossaryMetadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "TranslationServiceClient": - 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__) - - -__all__ = ( - "TranslationServiceClient", -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/pagers.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/pagers.py deleted file mode 100644 index e1a728c9..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/pagers.py +++ /dev/null @@ -1,139 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.translate_v3.types import translation_service - - -class ListGlossariesPager: - """A pager for iterating through ``list_glossaries`` requests. - - This class thinly wraps an initial - :class:`google.cloud.translate_v3.types.ListGlossariesResponse` object, and - provides an ``__iter__`` method to iterate through its - ``glossaries`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListGlossaries`` requests and continue to iterate - through the ``glossaries`` field on the - corresponding responses. - - All the usual :class:`google.cloud.translate_v3.types.ListGlossariesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., translation_service.ListGlossariesResponse], - request: translation_service.ListGlossariesRequest, - response: translation_service.ListGlossariesResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.translate_v3.types.ListGlossariesRequest): - The initial request object. - response (google.cloud.translate_v3.types.ListGlossariesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = translation_service.ListGlossariesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[translation_service.ListGlossariesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[translation_service.Glossary]: - for page in self.pages: - yield from page.glossaries - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListGlossariesAsyncPager: - """A pager for iterating through ``list_glossaries`` requests. - - This class thinly wraps an initial - :class:`google.cloud.translate_v3.types.ListGlossariesResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``glossaries`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListGlossaries`` requests and continue to iterate - through the ``glossaries`` field on the - corresponding responses. - - All the usual :class:`google.cloud.translate_v3.types.ListGlossariesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[translation_service.ListGlossariesResponse]], - request: translation_service.ListGlossariesRequest, - response: translation_service.ListGlossariesResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.translate_v3.types.ListGlossariesRequest): - The initial request object. - response (google.cloud.translate_v3.types.ListGlossariesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = translation_service.ListGlossariesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[translation_service.ListGlossariesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[translation_service.Glossary]: - async def async_generator(): - async for page in self.pages: - for response in page.glossaries: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/__init__.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/__init__.py deleted file mode 100644 index 40bc74be..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslationServiceTransport -from .grpc import TranslationServiceGrpcTransport -from .grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .rest import TranslationServiceRestTransport -from .rest import TranslationServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[TranslationServiceTransport]] -_transport_registry['grpc'] = TranslationServiceGrpcTransport -_transport_registry['grpc_asyncio'] = TranslationServiceGrpcAsyncIOTransport -_transport_registry['rest'] = TranslationServiceRestTransport - -__all__ = ( - 'TranslationServiceTransport', - 'TranslationServiceGrpcTransport', - 'TranslationServiceGrpcAsyncIOTransport', - 'TranslationServiceRestTransport', - 'TranslationServiceRestInterceptor', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/base.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/base.py deleted file mode 100644 index 84926d1c..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/base.py +++ /dev/null @@ -1,310 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.cloud.translate_v3 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.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.translate_v3.types import translation_service -from google.longrunning import operations_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class TranslationServiceTransport(abc.ABC): - """Abstract transport class for TranslationService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', - ) - - DEFAULT_HOST: str = 'translate.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. - 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 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: - 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 - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.translate_text: gapic_v1.method.wrap_method( - self.translate_text, - default_timeout=600.0, - client_info=client_info, - ), - self.detect_language: gapic_v1.method.wrap_method( - self.detect_language, - default_timeout=600.0, - client_info=client_info, - ), - self.get_supported_languages: gapic_v1.method.wrap_method( - self.get_supported_languages, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.translate_document: gapic_v1.method.wrap_method( - self.translate_document, - default_timeout=600.0, - client_info=client_info, - ), - self.batch_translate_text: gapic_v1.method.wrap_method( - self.batch_translate_text, - default_timeout=600.0, - client_info=client_info, - ), - self.batch_translate_document: gapic_v1.method.wrap_method( - self.batch_translate_document, - default_timeout=600.0, - client_info=client_info, - ), - self.create_glossary: gapic_v1.method.wrap_method( - self.create_glossary, - default_timeout=600.0, - client_info=client_info, - ), - self.list_glossaries: gapic_v1.method.wrap_method( - self.list_glossaries, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.get_glossary: gapic_v1.method.wrap_method( - self.get_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.delete_glossary: gapic_v1.method.wrap_method( - self.delete_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - 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 operations_client(self): - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - Union[ - translation_service.TranslateTextResponse, - Awaitable[translation_service.TranslateTextResponse] - ]]: - raise NotImplementedError() - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - Union[ - translation_service.DetectLanguageResponse, - Awaitable[translation_service.DetectLanguageResponse] - ]]: - raise NotImplementedError() - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - Union[ - translation_service.SupportedLanguages, - Awaitable[translation_service.SupportedLanguages] - ]]: - raise NotImplementedError() - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - Union[ - translation_service.TranslateDocumentResponse, - Awaitable[translation_service.TranslateDocumentResponse] - ]]: - raise NotImplementedError() - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - Union[ - translation_service.ListGlossariesResponse, - Awaitable[translation_service.ListGlossariesResponse] - ]]: - raise NotImplementedError() - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - Union[ - translation_service.Glossary, - Awaitable[translation_service.Glossary] - ]]: - raise NotImplementedError() - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'TranslationServiceTransport', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc.py deleted file mode 100644 index f3ab4d18..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc.py +++ /dev/null @@ -1,541 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import operations_v1 -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 - -import grpc # type: ignore - -from google.cloud.translate_v3.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO - - -class TranslationServiceGrpcTransport(TranslationServiceTransport): - """gRPC backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[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. - 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 ``channel`` 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 ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - 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 ``channel`` 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 ``channel`` 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] = {} - self._operations_client: Optional[operations_v1.OperationsClient] = None - - 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 channel: - # Ignore credentials if a channel was passed. - credentials = False - # 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: - self._grpc_channel = type(self).create_channel( - 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), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'translate.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 operations_client(self) -> operations_v1.OperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - translation_service.TranslateTextResponse]: - r"""Return a callable for the translate text method over gRPC. - - Translates input text and returns translated text. - - Returns: - Callable[[~.TranslateTextRequest], - ~.TranslateTextResponse]: - 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 'translate_text' not in self._stubs: - self._stubs['translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/TranslateText', - request_serializer=translation_service.TranslateTextRequest.serialize, - response_deserializer=translation_service.TranslateTextResponse.deserialize, - ) - return self._stubs['translate_text'] - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - translation_service.DetectLanguageResponse]: - r"""Return a callable for the detect language method over gRPC. - - Detects the language of text within a request. - - Returns: - Callable[[~.DetectLanguageRequest], - ~.DetectLanguageResponse]: - 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 'detect_language' not in self._stubs: - self._stubs['detect_language'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/DetectLanguage', - request_serializer=translation_service.DetectLanguageRequest.serialize, - response_deserializer=translation_service.DetectLanguageResponse.deserialize, - ) - return self._stubs['detect_language'] - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - translation_service.SupportedLanguages]: - r"""Return a callable for the get supported languages method over gRPC. - - Returns a list of supported languages for - translation. - - Returns: - Callable[[~.GetSupportedLanguagesRequest], - ~.SupportedLanguages]: - 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 'get_supported_languages' not in self._stubs: - self._stubs['get_supported_languages'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/GetSupportedLanguages', - request_serializer=translation_service.GetSupportedLanguagesRequest.serialize, - response_deserializer=translation_service.SupportedLanguages.deserialize, - ) - return self._stubs['get_supported_languages'] - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - translation_service.TranslateDocumentResponse]: - r"""Return a callable for the translate document method over gRPC. - - Translates documents in synchronous mode. - - Returns: - Callable[[~.TranslateDocumentRequest], - ~.TranslateDocumentResponse]: - 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 'translate_document' not in self._stubs: - self._stubs['translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/TranslateDocument', - request_serializer=translation_service.TranslateDocumentRequest.serialize, - response_deserializer=translation_service.TranslateDocumentResponse.deserialize, - ) - return self._stubs['translate_document'] - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - operations_pb2.Operation]: - r"""Return a callable for the batch translate text method over gRPC. - - Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - Returns: - Callable[[~.BatchTranslateTextRequest], - ~.Operation]: - 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 'batch_translate_text' not in self._stubs: - self._stubs['batch_translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/BatchTranslateText', - request_serializer=translation_service.BatchTranslateTextRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_text'] - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - operations_pb2.Operation]: - r"""Return a callable for the batch translate document method over gRPC. - - Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - Returns: - Callable[[~.BatchTranslateDocumentRequest], - ~.Operation]: - 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 'batch_translate_document' not in self._stubs: - self._stubs['batch_translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/BatchTranslateDocument', - request_serializer=translation_service.BatchTranslateDocumentRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_document'] - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - operations_pb2.Operation]: - r"""Return a callable for the create glossary method over gRPC. - - Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - Returns: - Callable[[~.CreateGlossaryRequest], - ~.Operation]: - 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_glossary' not in self._stubs: - self._stubs['create_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/CreateGlossary', - request_serializer=translation_service.CreateGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_glossary'] - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - translation_service.ListGlossariesResponse]: - r"""Return a callable for the list glossaries method over gRPC. - - Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - Returns: - Callable[[~.ListGlossariesRequest], - ~.ListGlossariesResponse]: - 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 'list_glossaries' not in self._stubs: - self._stubs['list_glossaries'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/ListGlossaries', - request_serializer=translation_service.ListGlossariesRequest.serialize, - response_deserializer=translation_service.ListGlossariesResponse.deserialize, - ) - return self._stubs['list_glossaries'] - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - translation_service.Glossary]: - r"""Return a callable for the get glossary method over gRPC. - - Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - Returns: - Callable[[~.GetGlossaryRequest], - ~.Glossary]: - 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 'get_glossary' not in self._stubs: - self._stubs['get_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/GetGlossary', - request_serializer=translation_service.GetGlossaryRequest.serialize, - response_deserializer=translation_service.Glossary.deserialize, - ) - return self._stubs['get_glossary'] - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete glossary method over gRPC. - - Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - Returns: - Callable[[~.DeleteGlossaryRequest], - ~.Operation]: - 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 'delete_glossary' not in self._stubs: - self._stubs['delete_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/DeleteGlossary', - request_serializer=translation_service.DeleteGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_glossary'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'TranslationServiceGrpcTransport', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc_asyncio.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc_asyncio.py deleted file mode 100644 index b7cd70df..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,540 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 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 operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.translate_v3.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import TranslationServiceGrpcTransport - - -class TranslationServiceGrpcAsyncIOTransport(TranslationServiceTransport): - """gRPC AsyncIO backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.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`. - This argument is ignored if ``channel`` 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`. - 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 = 'translate.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[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. - 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 ``channel`` 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 ``channel`` 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[aio.Channel]): A ``Channel`` instance through - which to make calls. - 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 ``channel`` 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 ``channel`` 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] = {} - self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None - - 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 channel: - # Ignore credentials if a channel was passed. - credentials = False - # 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: - self._grpc_channel = type(self).create_channel( - 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), - ], - ) - - # Wrap messages. This must be done after self._grpc_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 operations_client(self) -> operations_v1.OperationsAsyncClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsAsyncClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - Awaitable[translation_service.TranslateTextResponse]]: - r"""Return a callable for the translate text method over gRPC. - - Translates input text and returns translated text. - - Returns: - Callable[[~.TranslateTextRequest], - Awaitable[~.TranslateTextResponse]]: - 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 'translate_text' not in self._stubs: - self._stubs['translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/TranslateText', - request_serializer=translation_service.TranslateTextRequest.serialize, - response_deserializer=translation_service.TranslateTextResponse.deserialize, - ) - return self._stubs['translate_text'] - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - Awaitable[translation_service.DetectLanguageResponse]]: - r"""Return a callable for the detect language method over gRPC. - - Detects the language of text within a request. - - Returns: - Callable[[~.DetectLanguageRequest], - Awaitable[~.DetectLanguageResponse]]: - 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 'detect_language' not in self._stubs: - self._stubs['detect_language'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/DetectLanguage', - request_serializer=translation_service.DetectLanguageRequest.serialize, - response_deserializer=translation_service.DetectLanguageResponse.deserialize, - ) - return self._stubs['detect_language'] - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - Awaitable[translation_service.SupportedLanguages]]: - r"""Return a callable for the get supported languages method over gRPC. - - Returns a list of supported languages for - translation. - - Returns: - Callable[[~.GetSupportedLanguagesRequest], - Awaitable[~.SupportedLanguages]]: - 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 'get_supported_languages' not in self._stubs: - self._stubs['get_supported_languages'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/GetSupportedLanguages', - request_serializer=translation_service.GetSupportedLanguagesRequest.serialize, - response_deserializer=translation_service.SupportedLanguages.deserialize, - ) - return self._stubs['get_supported_languages'] - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - Awaitable[translation_service.TranslateDocumentResponse]]: - r"""Return a callable for the translate document method over gRPC. - - Translates documents in synchronous mode. - - Returns: - Callable[[~.TranslateDocumentRequest], - Awaitable[~.TranslateDocumentResponse]]: - 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 'translate_document' not in self._stubs: - self._stubs['translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/TranslateDocument', - request_serializer=translation_service.TranslateDocumentRequest.serialize, - response_deserializer=translation_service.TranslateDocumentResponse.deserialize, - ) - return self._stubs['translate_document'] - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the batch translate text method over gRPC. - - Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - Returns: - Callable[[~.BatchTranslateTextRequest], - Awaitable[~.Operation]]: - 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 'batch_translate_text' not in self._stubs: - self._stubs['batch_translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/BatchTranslateText', - request_serializer=translation_service.BatchTranslateTextRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_text'] - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the batch translate document method over gRPC. - - Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - Returns: - Callable[[~.BatchTranslateDocumentRequest], - Awaitable[~.Operation]]: - 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 'batch_translate_document' not in self._stubs: - self._stubs['batch_translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/BatchTranslateDocument', - request_serializer=translation_service.BatchTranslateDocumentRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_document'] - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the create glossary method over gRPC. - - Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - Returns: - Callable[[~.CreateGlossaryRequest], - Awaitable[~.Operation]]: - 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_glossary' not in self._stubs: - self._stubs['create_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/CreateGlossary', - request_serializer=translation_service.CreateGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_glossary'] - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - Awaitable[translation_service.ListGlossariesResponse]]: - r"""Return a callable for the list glossaries method over gRPC. - - Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - Returns: - Callable[[~.ListGlossariesRequest], - Awaitable[~.ListGlossariesResponse]]: - 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 'list_glossaries' not in self._stubs: - self._stubs['list_glossaries'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/ListGlossaries', - request_serializer=translation_service.ListGlossariesRequest.serialize, - response_deserializer=translation_service.ListGlossariesResponse.deserialize, - ) - return self._stubs['list_glossaries'] - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - Awaitable[translation_service.Glossary]]: - r"""Return a callable for the get glossary method over gRPC. - - Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - Returns: - Callable[[~.GetGlossaryRequest], - Awaitable[~.Glossary]]: - 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 'get_glossary' not in self._stubs: - self._stubs['get_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/GetGlossary', - request_serializer=translation_service.GetGlossaryRequest.serialize, - response_deserializer=translation_service.Glossary.deserialize, - ) - return self._stubs['get_glossary'] - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete glossary method over gRPC. - - Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - Returns: - Callable[[~.DeleteGlossaryRequest], - Awaitable[~.Operation]]: - 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 'delete_glossary' not in self._stubs: - self._stubs['delete_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3.TranslationService/DeleteGlossary', - request_serializer=translation_service.DeleteGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_glossary'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'TranslationServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/rest.py b/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/rest.py deleted file mode 100644 index 8601de00..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/services/translation_service/transports/rest.py +++ /dev/null @@ -1,1421 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # 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 path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from google.api_core import operations_v1 -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - - -from google.cloud.translate_v3.types import translation_service -from google.longrunning import operations_pb2 # type: ignore - -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class TranslationServiceRestInterceptor: - """Interceptor for TranslationService. - - 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 TranslationServiceRestTransport. - - .. code-block:: python - class MyCustomTranslationServiceInterceptor(TranslationServiceRestInterceptor): - def pre_batch_translate_document(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_batch_translate_document(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_batch_translate_text(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_batch_translate_text(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_delete_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_detect_language(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_detect_language(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_supported_languages(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_supported_languages(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_glossaries(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_glossaries(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_translate_document(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_translate_document(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_translate_text(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_translate_text(self, response): - logging.log(f"Received response: {response}") - return response - - transport = TranslationServiceRestTransport(interceptor=MyCustomTranslationServiceInterceptor()) - client = TranslationServiceClient(transport=transport) - - - """ - def pre_batch_translate_document(self, request: translation_service.BatchTranslateDocumentRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.BatchTranslateDocumentRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for batch_translate_document - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_batch_translate_document(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for batch_translate_document - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_batch_translate_text(self, request: translation_service.BatchTranslateTextRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.BatchTranslateTextRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for batch_translate_text - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_batch_translate_text(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for batch_translate_text - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_create_glossary(self, request: translation_service.CreateGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.CreateGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for create_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_create_glossary(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for create_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_delete_glossary(self, request: translation_service.DeleteGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.DeleteGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_delete_glossary(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for delete_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_detect_language(self, request: translation_service.DetectLanguageRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.DetectLanguageRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for detect_language - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_detect_language(self, response: translation_service.DetectLanguageResponse) -> translation_service.DetectLanguageResponse: - """Post-rpc interceptor for detect_language - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_get_glossary(self, request: translation_service.GetGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.GetGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_get_glossary(self, response: translation_service.Glossary) -> translation_service.Glossary: - """Post-rpc interceptor for get_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_get_supported_languages(self, request: translation_service.GetSupportedLanguagesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.GetSupportedLanguagesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_supported_languages - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_get_supported_languages(self, response: translation_service.SupportedLanguages) -> translation_service.SupportedLanguages: - """Post-rpc interceptor for get_supported_languages - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_list_glossaries(self, request: translation_service.ListGlossariesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.ListGlossariesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_glossaries - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_list_glossaries(self, response: translation_service.ListGlossariesResponse) -> translation_service.ListGlossariesResponse: - """Post-rpc interceptor for list_glossaries - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_translate_document(self, request: translation_service.TranslateDocumentRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.TranslateDocumentRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for translate_document - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_translate_document(self, response: translation_service.TranslateDocumentResponse) -> translation_service.TranslateDocumentResponse: - """Post-rpc interceptor for translate_document - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_translate_text(self, request: translation_service.TranslateTextRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.TranslateTextRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for translate_text - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_translate_text(self, response: translation_service.TranslateTextResponse) -> translation_service.TranslateTextResponse: - """Post-rpc interceptor for translate_text - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class TranslationServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: TranslationServiceRestInterceptor - - -class TranslationServiceRestTransport(TranslationServiceTransport): - """REST backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.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[TranslationServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - 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 - 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 - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or TranslationServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - @property - def operations_client(self) -> operations_v1.AbstractOperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Only create a new client if we do not already have one. - if self._operations_client is None: - http_options: Dict[str, List[Dict[str, str]]] = { - 'google.longrunning.Operations.CancelOperation': [ - { - 'method': 'post', - 'uri': '/v3/{name=projects/*/locations/*/operations/*}:cancel', - 'body': '*', - }, - ], - 'google.longrunning.Operations.DeleteOperation': [ - { - 'method': 'delete', - 'uri': '/v3/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.GetOperation': [ - { - 'method': 'get', - 'uri': '/v3/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.ListOperations': [ - { - 'method': 'get', - 'uri': '/v3/{name=projects/*/locations/*}/operations', - }, - ], - 'google.longrunning.Operations.WaitOperation': [ - { - 'method': 'post', - 'uri': '/v3/{name=projects/*/locations/*/operations/*}:wait', - 'body': '*', - }, - ], - } - - rest_transport = operations_v1.OperationsRestTransport( - host=self._host, - # use the credentials which are saved - credentials=self._credentials, - scopes=self._scopes, - http_options=http_options, - path_prefix="v3") - - self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) - - # Return the client from cache. - return self._operations_client - - class _BatchTranslateDocument(TranslationServiceRestStub): - def __hash__(self): - return hash("BatchTranslateDocument") - - __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} - - def __call__(self, - request: translation_service.BatchTranslateDocumentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the batch translate document method over HTTP. - - Args: - request (~.translation_service.BatchTranslateDocumentRequest): - The request object. The BatchTranslateDocument request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}:batchTranslateDocument', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_batch_translate_document(request, metadata) - pb_request = translation_service.BatchTranslateDocumentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_batch_translate_document(resp) - return resp - - class _BatchTranslateText(TranslationServiceRestStub): - def __hash__(self): - return hash("BatchTranslateText") - - __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} - - def __call__(self, - request: translation_service.BatchTranslateTextRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the batch translate text method over HTTP. - - Args: - request (~.translation_service.BatchTranslateTextRequest): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}:batchTranslateText', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_batch_translate_text(request, metadata) - pb_request = translation_service.BatchTranslateTextRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_batch_translate_text(resp) - return resp - - class _CreateGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("CreateGlossary") - - __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} - - def __call__(self, - request: translation_service.CreateGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the create glossary method over HTTP. - - Args: - request (~.translation_service.CreateGlossaryRequest): - The request object. Request message for CreateGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}/glossaries', - 'body': 'glossary', - }, - ] - request, metadata = self._interceptor.pre_create_glossary(request, metadata) - pb_request = translation_service.CreateGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_create_glossary(resp) - return resp - - class _DeleteGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("DeleteGlossary") - - __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} - - def __call__(self, - request: translation_service.DeleteGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the delete glossary method over HTTP. - - Args: - request (~.translation_service.DeleteGlossaryRequest): - The request object. Request message for DeleteGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v3/{name=projects/*/locations/*/glossaries/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_glossary(request, metadata) - pb_request = translation_service.DeleteGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_delete_glossary(resp) - return resp - - class _DetectLanguage(TranslationServiceRestStub): - def __hash__(self): - return hash("DetectLanguage") - - __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} - - def __call__(self, - request: translation_service.DetectLanguageRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.DetectLanguageResponse: - r"""Call the detect language method over HTTP. - - Args: - request (~.translation_service.DetectLanguageRequest): - The request object. The request message for language - detection. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.DetectLanguageResponse: - The response message for language - detection. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}:detectLanguage', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*}:detectLanguage', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_detect_language(request, metadata) - pb_request = translation_service.DetectLanguageRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.DetectLanguageResponse() - pb_resp = translation_service.DetectLanguageResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_detect_language(resp) - return resp - - class _GetGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("GetGlossary") - - __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} - - def __call__(self, - request: translation_service.GetGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.Glossary: - r"""Call the get glossary method over HTTP. - - Args: - request (~.translation_service.GetGlossaryRequest): - The request object. Request message for GetGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.Glossary: - Represents a glossary built from - user-provided data. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3/{name=projects/*/locations/*/glossaries/*}', - }, - ] - request, metadata = self._interceptor.pre_get_glossary(request, metadata) - pb_request = translation_service.GetGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.Glossary() - pb_resp = translation_service.Glossary.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_glossary(resp) - return resp - - class _GetSupportedLanguages(TranslationServiceRestStub): - def __hash__(self): - return hash("GetSupportedLanguages") - - __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} - - def __call__(self, - request: translation_service.GetSupportedLanguagesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.SupportedLanguages: - r"""Call the get supported languages method over HTTP. - - Args: - request (~.translation_service.GetSupportedLanguagesRequest): - The request object. The request message for discovering - supported languages. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.SupportedLanguages: - The response message for discovering - supported languages. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3/{parent=projects/*/locations/*}/supportedLanguages', - }, -{ - 'method': 'get', - 'uri': '/v3/{parent=projects/*}/supportedLanguages', - }, - ] - request, metadata = self._interceptor.pre_get_supported_languages(request, metadata) - pb_request = translation_service.GetSupportedLanguagesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.SupportedLanguages() - pb_resp = translation_service.SupportedLanguages.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_supported_languages(resp) - return resp - - class _ListGlossaries(TranslationServiceRestStub): - def __hash__(self): - return hash("ListGlossaries") - - __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} - - def __call__(self, - request: translation_service.ListGlossariesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.ListGlossariesResponse: - r"""Call the list glossaries method over HTTP. - - Args: - request (~.translation_service.ListGlossariesRequest): - The request object. Request message for ListGlossaries. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.ListGlossariesResponse: - Response message for ListGlossaries. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3/{parent=projects/*/locations/*}/glossaries', - }, - ] - request, metadata = self._interceptor.pre_list_glossaries(request, metadata) - pb_request = translation_service.ListGlossariesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.ListGlossariesResponse() - pb_resp = translation_service.ListGlossariesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_glossaries(resp) - return resp - - class _TranslateDocument(TranslationServiceRestStub): - def __hash__(self): - return hash("TranslateDocument") - - __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} - - def __call__(self, - request: translation_service.TranslateDocumentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.TranslateDocumentResponse: - r"""Call the translate document method over HTTP. - - Args: - request (~.translation_service.TranslateDocumentRequest): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.TranslateDocumentResponse: - A translated document response - message. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}:translateDocument', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_translate_document(request, metadata) - pb_request = translation_service.TranslateDocumentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.TranslateDocumentResponse() - pb_resp = translation_service.TranslateDocumentResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_translate_document(resp) - return resp - - class _TranslateText(TranslationServiceRestStub): - def __hash__(self): - return hash("TranslateText") - - __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} - - def __call__(self, - request: translation_service.TranslateTextRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.TranslateTextResponse: - r"""Call the translate text method over HTTP. - - Args: - request (~.translation_service.TranslateTextRequest): - The request object. The request message for synchronous - translation. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.TranslateTextResponse: - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*/locations/*}:translateText', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v3/{parent=projects/*}:translateText', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_translate_text(request, metadata) - pb_request = translation_service.TranslateTextRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.TranslateTextResponse() - pb_resp = translation_service.TranslateTextResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_translate_text(resp) - return resp - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - operations_pb2.Operation]: - # 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._BatchTranslateDocument(self._session, self._host, self._interceptor) # type: ignore - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - operations_pb2.Operation]: - # 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._BatchTranslateText(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - operations_pb2.Operation]: - # 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._CreateGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - operations_pb2.Operation]: - # 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._DeleteGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - translation_service.DetectLanguageResponse]: - # 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._DetectLanguage(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - translation_service.Glossary]: - # 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._GetGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - translation_service.SupportedLanguages]: - # 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._GetSupportedLanguages(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - translation_service.ListGlossariesResponse]: - # 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._ListGlossaries(self._session, self._host, self._interceptor) # type: ignore - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - translation_service.TranslateDocumentResponse]: - # 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._TranslateDocument(self._session, self._host, self._interceptor) # type: ignore - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - translation_service.TranslateTextResponse]: - # 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._TranslateText(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'TranslationServiceRestTransport', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/types/__init__.py b/owl-bot-staging/v3/google/cloud/translate_v3/types/__init__.py deleted file mode 100644 index 3218bd8e..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/types/__init__.py +++ /dev/null @@ -1,94 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 .translation_service import ( - BatchDocumentInputConfig, - BatchDocumentOutputConfig, - BatchTranslateDocumentMetadata, - BatchTranslateDocumentRequest, - BatchTranslateDocumentResponse, - BatchTranslateMetadata, - BatchTranslateResponse, - BatchTranslateTextRequest, - CreateGlossaryMetadata, - CreateGlossaryRequest, - DeleteGlossaryMetadata, - DeleteGlossaryRequest, - DeleteGlossaryResponse, - DetectedLanguage, - DetectLanguageRequest, - DetectLanguageResponse, - DocumentInputConfig, - DocumentOutputConfig, - DocumentTranslation, - GcsDestination, - GcsSource, - GetGlossaryRequest, - GetSupportedLanguagesRequest, - Glossary, - GlossaryInputConfig, - InputConfig, - ListGlossariesRequest, - ListGlossariesResponse, - OutputConfig, - SupportedLanguage, - SupportedLanguages, - TranslateDocumentRequest, - TranslateDocumentResponse, - TranslateTextGlossaryConfig, - TranslateTextRequest, - TranslateTextResponse, - Translation, -) - -__all__ = ( - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentMetadata', - 'BatchTranslateDocumentRequest', - 'BatchTranslateDocumentResponse', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'BatchTranslateTextRequest', - 'CreateGlossaryMetadata', - 'CreateGlossaryRequest', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryRequest', - 'DeleteGlossaryResponse', - 'DetectedLanguage', - 'DetectLanguageRequest', - 'DetectLanguageResponse', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'DocumentTranslation', - 'GcsDestination', - 'GcsSource', - 'GetGlossaryRequest', - 'GetSupportedLanguagesRequest', - 'Glossary', - 'GlossaryInputConfig', - 'InputConfig', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'OutputConfig', - 'SupportedLanguage', - 'SupportedLanguages', - 'TranslateDocumentRequest', - 'TranslateDocumentResponse', - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', -) diff --git a/owl-bot-staging/v3/google/cloud/translate_v3/types/translation_service.py b/owl-bot-staging/v3/google/cloud/translate_v3/types/translation_service.py deleted file mode 100644 index a6965e0d..00000000 --- a/owl-bot-staging/v3/google/cloud/translate_v3/types/translation_service.py +++ /dev/null @@ -1,2194 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.translation.v3', - manifest={ - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', - 'DetectLanguageRequest', - 'DetectedLanguage', - 'DetectLanguageResponse', - 'GetSupportedLanguagesRequest', - 'SupportedLanguages', - 'SupportedLanguage', - 'GcsSource', - 'InputConfig', - 'GcsDestination', - 'OutputConfig', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'TranslateDocumentRequest', - 'DocumentTranslation', - 'TranslateDocumentResponse', - 'BatchTranslateTextRequest', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'GlossaryInputConfig', - 'Glossary', - 'CreateGlossaryRequest', - 'GetGlossaryRequest', - 'DeleteGlossaryRequest', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'CreateGlossaryMetadata', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryResponse', - 'BatchTranslateDocumentRequest', - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentResponse', - 'BatchTranslateDocumentMetadata', - }, -) - - -class TranslateTextGlossaryConfig(proto.Message): - r"""Configures which glossary is used for a specific target - language and defines options for applying that glossary. - - Attributes: - glossary (str): - Required. The ``glossary`` to be applied for this - translation. - - The format depends on the glossary: - - - User-provided custom glossary: - ``projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`` - ignore_case (bool): - Optional. Indicates match is case insensitive. The default - value is ``false`` if missing. - """ - - glossary: str = proto.Field( - proto.STRING, - number=1, - ) - ignore_case: bool = proto.Field( - proto.BOOL, - number=2, - ) - - -class TranslateTextRequest(proto.Message): - r"""The request message for synchronous translation. - - Attributes: - contents (MutableSequence[str]): - Required. The content of the input in string - format. We recommend the total content be less - than 30,000 codepoints. The max length of this - field is 1024. Use BatchTranslateText for larger - text. - mime_type (str): - Optional. The format of the source text, for - example, "text/html", "text/plain". If left - blank, the MIME type defaults to "text/html". - source_language_code (str): - Optional. The ISO-639 language code of the - input text if known, for example, "en-US" or - "sr-Latn". Supported language codes are listed - in Language Support. If the source language - isn't specified, the API attempts to identify - the source language automatically and returns - the source language within the response. - target_language_code (str): - Required. The ISO-639 language code to use - for translation of the input text, set to one of - the language codes listed in Language Support. - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for requests using AutoML - models or custom glossaries. - - Models and glossaries must be within the same region (have - same location-id), otherwise an INVALID_ARGUMENT (400) error - is returned. - model (str): - Optional. The ``model`` type requested for this translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - For global (non-regionalized) requests, use ``location-id`` - ``global``. For example, - ``projects/{project-number-or-id}/locations/global/models/general/nmt``. - - If not provided, the default Google model (NMT) will be used - glossary_config (google.cloud.translate_v3.types.TranslateTextGlossaryConfig): - Optional. Glossary to be applied. The glossary must be - within the same region (have the same location-id) as the - model, otherwise an INVALID_ARGUMENT (400) error is - returned. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/advanced/labels - for more information. - """ - - contents: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=4, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=5, - ) - parent: str = proto.Field( - proto.STRING, - number=8, - ) - model: str = proto.Field( - proto.STRING, - number=6, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=10, - ) - - -class TranslateTextResponse(proto.Message): - r""" - - Attributes: - translations (MutableSequence[google.cloud.translate_v3.types.Translation]): - Text translation responses with no glossary applied. This - field has the same length as - [``contents``][google.cloud.translation.v3.TranslateTextRequest.contents]. - glossary_translations (MutableSequence[google.cloud.translate_v3.types.Translation]): - Text translation responses if a glossary is provided in the - request. This can be the same as - [``translations``][google.cloud.translation.v3.TranslateTextResponse.translations] - if no terms apply. This field has the same length as - [``contents``][google.cloud.translation.v3.TranslateTextRequest.contents]. - """ - - translations: MutableSequence['Translation'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Translation', - ) - glossary_translations: MutableSequence['Translation'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Translation', - ) - - -class Translation(proto.Message): - r"""A single translation response. - - Attributes: - translated_text (str): - Text translated into the target language. - If an error occurs during translation, this - field might be excluded from the response. - model (str): - Only present when ``model`` is present in the request. - ``model`` here is normalized to have project number. - - For example: If the ``model`` requested in - TranslationTextRequest is - ``projects/{project-id}/locations/{location-id}/models/general/nmt`` - then ``model`` here would be normalized to - ``projects/{project-number}/locations/{location-id}/models/general/nmt``. - detected_language_code (str): - The ISO-639 language code of source text in - the initial request, detected automatically, if - no source language was passed within the initial - request. If the source language was passed, - auto-detection of the language does not occur - and this field is empty. - glossary_config (google.cloud.translate_v3.types.TranslateTextGlossaryConfig): - The ``glossary_config`` used for this translation. - """ - - translated_text: str = proto.Field( - proto.STRING, - number=1, - ) - model: str = proto.Field( - proto.STRING, - number=2, - ) - detected_language_code: str = proto.Field( - proto.STRING, - number=4, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=3, - message='TranslateTextGlossaryConfig', - ) - - -class DetectLanguageRequest(proto.Message): - r"""The request message for language detection. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same location-id) - can be used. Otherwise an INVALID_ARGUMENT (400) error is - returned. - model (str): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - content (str): - The content of the input stored as a string. - - This field is a member of `oneof`_ ``source``. - mime_type (str): - Optional. The format of the source text, for - example, "text/html", "text/plain". If left - blank, the MIME type defaults to "text/html". - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/advanced/labels - for more information. - """ - - parent: str = proto.Field( - proto.STRING, - number=5, - ) - model: str = proto.Field( - proto.STRING, - number=4, - ) - content: str = proto.Field( - proto.STRING, - number=1, - oneof='source', - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - - -class DetectedLanguage(proto.Message): - r"""The response message for language detection. - - Attributes: - language_code (str): - The ISO-639 language code of the source - content in the request, detected automatically. - confidence (float): - The confidence of the detection result for - this language. - """ - - language_code: str = proto.Field( - proto.STRING, - number=1, - ) - confidence: float = proto.Field( - proto.FLOAT, - number=2, - ) - - -class DetectLanguageResponse(proto.Message): - r"""The response message for language detection. - - Attributes: - languages (MutableSequence[google.cloud.translate_v3.types.DetectedLanguage]): - The most probable language detected by the - Translation API. For each request, the - Translation API will always return only one - result. - """ - - languages: MutableSequence['DetectedLanguage'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='DetectedLanguage', - ) - - -class GetSupportedLanguagesRequest(proto.Message): - r"""The request message for discovering supported languages. - - Attributes: - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same location-id) - can be used, otherwise an INVALID_ARGUMENT (400) error is - returned. - display_language_code (str): - Optional. The language to use to return - localized, human readable names of supported - languages. If missing, then display names are - not returned in a response. - model (str): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general NMT - model. - """ - - parent: str = proto.Field( - proto.STRING, - number=3, - ) - display_language_code: str = proto.Field( - proto.STRING, - number=1, - ) - model: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SupportedLanguages(proto.Message): - r"""The response message for discovering supported languages. - - Attributes: - languages (MutableSequence[google.cloud.translate_v3.types.SupportedLanguage]): - A list of supported language responses. This - list contains an entry for each language the - Translation API supports. - """ - - languages: MutableSequence['SupportedLanguage'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SupportedLanguage', - ) - - -class SupportedLanguage(proto.Message): - r"""A single supported language response corresponds to - information related to one supported language. - - Attributes: - language_code (str): - Supported language code, generally consisting - of its ISO 639-1 identifier, for example, 'en', - 'ja'. In certain cases, ISO-639 codes including - language and region identifiers are returned - (for example, 'zh-TW' and 'zh-CN'). - display_name (str): - Human-readable name of the language localized - in the display language specified in the - request. - support_source (bool): - Can be used as a source language. - support_target (bool): - Can be used as a target language. - """ - - language_code: str = proto.Field( - proto.STRING, - number=1, - ) - display_name: str = proto.Field( - proto.STRING, - number=2, - ) - support_source: bool = proto.Field( - proto.BOOL, - number=3, - ) - support_target: bool = proto.Field( - proto.BOOL, - number=4, - ) - - -class GcsSource(proto.Message): - r"""The Google Cloud Storage location for the input content. - - Attributes: - input_uri (str): - Required. Source data URI. For example, - ``gs://my_bucket/my_object``. - """ - - input_uri: str = proto.Field( - proto.STRING, - number=1, - ) - - -class InputConfig(proto.Message): - r"""Input configuration for BatchTranslateText request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - mime_type (str): - Optional. Can be "text/plain" or "text/html". For ``.tsv``, - "text/html" is used if mime_type is missing. For ``.html``, - this field must be "text/html" or empty. For ``.txt``, this - field must be "text/plain" or empty. - gcs_source (google.cloud.translate_v3.types.GcsSource): - Required. Google Cloud Storage location for the source - input. This can be a single file (for example, - ``gs://translation-test/input.tsv``) or a wildcard (for - example, ``gs://translation-test/*``). If a file extension - is ``.tsv``, it can contain either one or two columns. The - first column (optional) is the id of the text request. If - the first column is missing, we use the row number (0-based) - from the input file as the ID in the output file. The second - column is the actual text to be translated. We recommend - each row be <= 10K Unicode codepoints, otherwise an error - might be returned. Note that the input tsv must be RFC 4180 - compliant. - - You could use https://github.com/Clever/csvlint to check - potential formatting errors in your tsv file. csvlint - --delimiter='\t' your_input_file.tsv - - The other supported file extensions are ``.txt`` or - ``.html``, which is treated as a single large chunk of text. - - This field is a member of `oneof`_ ``source``. - """ - - mime_type: str = proto.Field( - proto.STRING, - number=1, - ) - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=2, - oneof='source', - message='GcsSource', - ) - - -class GcsDestination(proto.Message): - r"""The Google Cloud Storage location for the output content. - - Attributes: - output_uri_prefix (str): - Required. The bucket used in 'output_uri_prefix' must exist - and there must be no files under 'output_uri_prefix'. - 'output_uri_prefix' must end with "/" and start with - "gs://". One 'output_uri_prefix' can only be used by one - batch translation job at a time. Otherwise an - INVALID_ARGUMENT (400) error is returned. - """ - - output_uri_prefix: str = proto.Field( - proto.STRING, - number=1, - ) - - -class OutputConfig(proto.Message): - r"""Output configuration for BatchTranslateText request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3.types.GcsDestination): - Google Cloud Storage destination for output content. For - every single input file (for example, - gs://a/b/c.[extension]), we generate at most 2 \* n output - files. (n is the # of target_language_codes in the - BatchTranslateTextRequest). - - Output files (tsv) generated are compliant with RFC 4180 - except that record delimiters are '\n' instead of '\r\n'. We - don't provide any way to change record delimiters. - - While the input files are being processed, we write/update - an index file 'index.csv' under 'output_uri_prefix' (for - example, gs://translation-test/index.csv) The index file is - generated/updated as new files are being translated. The - format is: - - input_file,target_language_code,translations_file,errors_file, - glossary_translations_file,glossary_errors_file - - input_file is one file we matched using - gcs_source.input_uri. target_language_code is provided in - the request. translations_file contains the translations. - (details provided below) errors_file contains the errors - during processing of the file. (details below). Both - translations_file and errors_file could be empty strings if - we have no content to output. glossary_translations_file and - glossary_errors_file are always empty strings if the - input_file is tsv. They could also be empty if we have no - content to output. - - Once a row is present in index.csv, the input/output - matching never changes. Callers should also expect all the - content in input_file are processed and ready to be consumed - (that is, no partial output file is written). - - Since index.csv will be keeping updated during the process, - please make sure there is no custom retention policy applied - on the output bucket that may avoid file updating. - (https://cloud.google.com/storage/docs/bucket-lock#retention-policy) - - The format of translations_file (for target language code - 'trg') is: - ``gs://translation_test/a_b_c_'trg'_translations.[extension]`` - - If the input file extension is tsv, the output has the - following columns: Column 1: ID of the request provided in - the input, if it's not provided in the input, then the input - row number is used (0-based). Column 2: source sentence. - Column 3: translation without applying a glossary. Empty - string if there is an error. Column 4 (only present if a - glossary is provided in the request): translation after - applying the glossary. Empty string if there is an error - applying the glossary. Could be same string as column 3 if - there is no glossary applied. - - If input file extension is a txt or html, the translation is - directly written to the output file. If glossary is - requested, a separate glossary_translations_file has format - of - ``gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]`` - - The format of errors file (for target language code 'trg') - is: ``gs://translation_test/a_b_c_'trg'_errors.[extension]`` - - If the input file extension is tsv, errors_file contains the - following: Column 1: ID of the request provided in the - input, if it's not provided in the input, then the input row - number is used (0-based). Column 2: source sentence. Column - 3: Error detail for the translation. Could be empty. Column - 4 (only present if a glossary is provided in the request): - Error when applying the glossary. - - If the input file extension is txt or html, - glossary_error_file will be generated that contains error - details. glossary_error_file has format of - ``gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]`` - - This field is a member of `oneof`_ ``destination``. - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - - -class DocumentInputConfig(proto.Message): - r"""A document translation request input config. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - content (bytes): - Document's content represented as a stream of - bytes. - - This field is a member of `oneof`_ ``source``. - gcs_source (google.cloud.translate_v3.types.GcsSource): - Google Cloud Storage location. This must be a single file. - For example: gs://example_bucket/example_file.pdf - - This field is a member of `oneof`_ ``source``. - mime_type (str): - Specifies the input document's mime_type. - - If not specified it will be determined using the file - extension for gcs_source provided files. For a file provided - through bytes content the mime_type must be provided. - Currently supported mime types are: - - - application/pdf - - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - application/vnd.openxmlformats-officedocument.presentationml.presentation - - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - """ - - content: bytes = proto.Field( - proto.BYTES, - number=1, - oneof='source', - ) - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=2, - oneof='source', - message='GcsSource', - ) - mime_type: str = proto.Field( - proto.STRING, - number=4, - ) - - -class DocumentOutputConfig(proto.Message): - r"""A document translation request output config. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3.types.GcsDestination): - Optional. Google Cloud Storage destination for the - translation output, e.g., ``gs://my_bucket/my_directory/``. - - The destination directory provided does not have to be - empty, but the bucket must exist. If a file with the same - name as the output file already exists in the destination an - error will be returned. - - For a DocumentInputConfig.contents provided document, the - output file will have the name - "output_[trg]_translations.[ext]", where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - For a DocumentInputConfig.gcs_uri provided document, the - output file will have a name according to its URI. For - example: an input file with URI: ``gs://a/b/c.[extension]`` - stored in a gcs_destination bucket with name "my_bucket" - will have an output URI: - ``gs://my_bucket/a_b_c_[trg]_translations.[ext]``, where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - If the document was directly provided through the request, - then the output document will have the format: - ``gs://my_bucket/translated_document_[trg]_translations.[ext]``, - where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - If a glossary was provided, then the output URI for the - glossary translation will be equal to the default output URI - but have ``glossary_translations`` instead of - ``translations``. For the previous example, its glossary URI - would be: - ``gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]``. - - Thus the max number of output files will be 2 (Translated - document, Glossary translated document). - - Callers should expect no partial outputs. If there is any - error during document translation, no output will be stored - in the Cloud Storage bucket. - - This field is a member of `oneof`_ ``destination``. - mime_type (str): - Optional. Specifies the translated document's mime_type. If - not specified, the translated file's mime type will be the - same as the input file's mime type. Currently only support - the output mime type to be the same as input mime type. - - - application/pdf - - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - application/vnd.openxmlformats-officedocument.presentationml.presentation - - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - - -class TranslateDocumentRequest(proto.Message): - r"""A document translation request. - - Attributes: - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for requests using AutoML - models or custom glossaries. - - Models and glossaries must be within the same region (have - the same location-id), otherwise an INVALID_ARGUMENT (400) - error is returned. - source_language_code (str): - Optional. The ISO-639 language code of the - input document if known, for example, "en-US" or - "sr-Latn". Supported language codes are listed - in Language Support. If the source language - isn't specified, the API attempts to identify - the source language automatically and returns - the source language within the response. Source - language must be specified if the request - contains a glossary or a custom model. - target_language_code (str): - Required. The ISO-639 language code to use - for translation of the input document, set to - one of the language codes listed in Language - Support. - document_input_config (google.cloud.translate_v3.types.DocumentInputConfig): - Required. Input configurations. - document_output_config (google.cloud.translate_v3.types.DocumentOutputConfig): - Optional. Output configurations. - Defines if the output file should be stored - within Cloud Storage as well as the desired - output format. If not provided the translated - file will only be returned through a byte-stream - and its output mime type will be the same as the - input file's mime type. - model (str): - Optional. The ``model`` type requested for this translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If not provided, the default Google model (NMT) will be used - for translation. - glossary_config (google.cloud.translate_v3.types.TranslateTextGlossaryConfig): - Optional. Glossary to be applied. The glossary must be - within the same region (have the same location-id) as the - model, otherwise an INVALID_ARGUMENT (400) error is - returned. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/advanced/labels - for more information. - customized_attribution (str): - Optional. This flag is to support user customized - attribution. If not provided, the default is - ``Machine Translated by Google``. Customized attribution - should follow rules in - https://cloud.google.com/translate/attribution#attribution_and_logos - is_translate_native_pdf_only (bool): - Optional. is_translate_native_pdf_only field for external - customers. If true, the page limit of online native pdf - translation is 300 and only native pdf pages will be - translated. - enable_shadow_removal_native_pdf (bool): - Optional. If true, use the text removal server to remove the - shadow text on background image for native pdf translation. - Shadow removal feature can only be enabled when - is_translate_native_pdf_only: false && pdf_native_only: - false - enable_rotation_correction (bool): - Optional. If true, enable auto rotation - correction in DVS. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=3, - ) - document_input_config: 'DocumentInputConfig' = proto.Field( - proto.MESSAGE, - number=4, - message='DocumentInputConfig', - ) - document_output_config: 'DocumentOutputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='DocumentOutputConfig', - ) - model: str = proto.Field( - proto.STRING, - number=6, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=8, - ) - customized_attribution: str = proto.Field( - proto.STRING, - number=10, - ) - is_translate_native_pdf_only: bool = proto.Field( - proto.BOOL, - number=11, - ) - enable_shadow_removal_native_pdf: bool = proto.Field( - proto.BOOL, - number=12, - ) - enable_rotation_correction: bool = proto.Field( - proto.BOOL, - number=13, - ) - - -class DocumentTranslation(proto.Message): - r"""A translated document message. - - Attributes: - byte_stream_outputs (MutableSequence[bytes]): - The array of translated documents. It is - expected to be size 1 for now. We may produce - multiple translated documents in the future for - other type of file formats. - mime_type (str): - The translated document's mime type. - detected_language_code (str): - The detected language for the input document. - If the user did not provide the source language - for the input document, this field will have the - language code automatically detected. If the - source language was passed, auto-detection of - the language does not occur and this field is - empty. - """ - - byte_stream_outputs: MutableSequence[bytes] = proto.RepeatedField( - proto.BYTES, - number=1, - ) - mime_type: str = proto.Field( - proto.STRING, - number=2, - ) - detected_language_code: str = proto.Field( - proto.STRING, - number=3, - ) - - -class TranslateDocumentResponse(proto.Message): - r"""A translated document response message. - - Attributes: - document_translation (google.cloud.translate_v3.types.DocumentTranslation): - Translated document. - glossary_document_translation (google.cloud.translate_v3.types.DocumentTranslation): - The document's translation output if a glossary is provided - in the request. This can be the same as - [TranslateDocumentResponse.document_translation] if no - glossary terms apply. - model (str): - Only present when 'model' is present in the request. 'model' - is normalized to have a project number. - - For example: If the 'model' field in - TranslateDocumentRequest is: - ``projects/{project-id}/locations/{location-id}/models/general/nmt`` - then ``model`` here would be normalized to - ``projects/{project-number}/locations/{location-id}/models/general/nmt``. - glossary_config (google.cloud.translate_v3.types.TranslateTextGlossaryConfig): - The ``glossary_config`` used for this translation. - """ - - document_translation: 'DocumentTranslation' = proto.Field( - proto.MESSAGE, - number=1, - message='DocumentTranslation', - ) - glossary_document_translation: 'DocumentTranslation' = proto.Field( - proto.MESSAGE, - number=2, - message='DocumentTranslation', - ) - model: str = proto.Field( - proto.STRING, - number=3, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=4, - message='TranslateTextGlossaryConfig', - ) - - -class BatchTranslateTextRequest(proto.Message): - r"""The batch translation request. - - Attributes: - parent (str): - Required. Location to make a call. Must refer to a caller's - project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the same - region (have the same location-id) can be used, otherwise an - INVALID_ARGUMENT (400) error is returned. - source_language_code (str): - Required. Source language code. - target_language_codes (MutableSequence[str]): - Required. Specify up to 10 language codes - here. - models (MutableMapping[str, str]): - Optional. The models to use for translation. Map's key is - target language code. Map's value is model name. Value can - be a built-in general model, or an AutoML Translation model. - - The value format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If the map is empty or a specific model is not requested for - a language pair, then default google model (nmt) is used. - input_configs (MutableSequence[google.cloud.translate_v3.types.InputConfig]): - Required. Input configurations. - The total number of files matched should be <= - 100. The total content size should be <= 100M - Unicode codepoints. The files must use UTF-8 - encoding. - output_config (google.cloud.translate_v3.types.OutputConfig): - Required. Output configuration. - If 2 input configs match to the same file (that - is, same input path), we don't generate output - for duplicate inputs. - glossaries (MutableMapping[str, google.cloud.translate_v3.types.TranslateTextGlossaryConfig]): - Optional. Glossaries to be applied for - translation. It's keyed by target language code. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/advanced/labels - for more information. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - models: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - input_configs: MutableSequence['InputConfig'] = proto.RepeatedField( - proto.MESSAGE, - number=5, - message='InputConfig', - ) - output_config: 'OutputConfig' = proto.Field( - proto.MESSAGE, - number=6, - message='OutputConfig', - ) - glossaries: MutableMapping[str, 'TranslateTextGlossaryConfig'] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=9, - ) - - -class BatchTranslateMetadata(proto.Message): - r"""State metadata for the batch translation operation. - - Attributes: - state (google.cloud.translate_v3.types.BatchTranslateMetadata.State): - The state of the operation. - translated_characters (int): - Number of successfully translated characters - so far (Unicode codepoints). - failed_characters (int): - Number of characters that have failed to - process so far (Unicode codepoints). - total_characters (int): - Total number of characters (Unicode - codepoints). This is the total number of - codepoints from input files times the number of - target languages and appears here shortly after - the call is submitted. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - """ - class State(proto.Enum): - r"""State of the job. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The batch is processed, and at least one item - was successfully processed. - FAILED (3): - The batch is done and no item was - successfully processed. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The batch is done after the user has called - the longrunning.Operations.CancelOperation. Any - records processed before the cancel command are - output as specified in the request. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - state: State = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=2, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=3, - ) - total_characters: int = proto.Field( - proto.INT64, - number=4, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one sentence is - translated successfully. - - Attributes: - total_characters (int): - Total number of characters (Unicode - codepoints). - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints). - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints). - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - total_characters: int = proto.Field( - proto.INT64, - number=1, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=2, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=3, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - - -class GlossaryInputConfig(proto.Message): - r"""Input configuration for glossaries. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_source (google.cloud.translate_v3.types.GcsSource): - Required. Google Cloud Storage location of glossary data. - File format is determined based on the filename extension. - API returns [google.rpc.Code.INVALID_ARGUMENT] for - unsupported URI-s and file formats. Wildcards are not - allowed. This must be a single file in one of the following - formats: - - For unidirectional glossaries: - - - TSV/CSV (``.tsv``/``.csv``): Two column file, tab- or - comma-separated. The first column is source text. The - second column is target text. No headers in this file. - The first row contains data and not column names. - - - TMX (``.tmx``): TMX file with parallel data defining - source/target term pairs. - - For equivalent term sets glossaries: - - - CSV (``.csv``): Multi-column CSV file defining equivalent - glossary terms in multiple languages. See documentation - for more information - - `glossaries `__. - - This field is a member of `oneof`_ ``source``. - """ - - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=1, - oneof='source', - message='GcsSource', - ) - - -class Glossary(proto.Message): - r"""Represents a glossary built from user-provided data. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - name (str): - Required. The resource name of the glossary. Glossary names - have the form - ``projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}``. - language_pair (google.cloud.translate_v3.types.Glossary.LanguageCodePair): - Used with unidirectional glossaries. - - This field is a member of `oneof`_ ``languages``. - language_codes_set (google.cloud.translate_v3.types.Glossary.LanguageCodesSet): - Used with equivalent term set glossaries. - - This field is a member of `oneof`_ ``languages``. - input_config (google.cloud.translate_v3.types.GlossaryInputConfig): - Required. Provides examples to build the - glossary from. Total glossary must not exceed - 10M Unicode codepoints. - entry_count (int): - Output only. The number of entries defined in - the glossary. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. When CreateGlossary was called. - end_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. When the glossary creation was - finished. - display_name (str): - Optional. The display name of the glossary. - """ - - class LanguageCodePair(proto.Message): - r"""Used with unidirectional glossaries. - - Attributes: - source_language_code (str): - Required. The ISO-639 language code of the input text, for - example, "en-US". Expected to be an exact match for - GlossaryTerm.language_code. - target_language_code (str): - Required. The ISO-639 language code for translation output, - for example, "zh-CN". Expected to be an exact match for - GlossaryTerm.language_code. - """ - - source_language_code: str = proto.Field( - proto.STRING, - number=1, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - - class LanguageCodesSet(proto.Message): - r"""Used with equivalent term set glossaries. - - Attributes: - language_codes (MutableSequence[str]): - The ISO-639 language code(s) for terms defined in the - glossary. All entries are unique. The list contains at least - two entries. Expected to be an exact match for - GlossaryTerm.language_code. - """ - - language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - - name: str = proto.Field( - proto.STRING, - number=1, - ) - language_pair: LanguageCodePair = proto.Field( - proto.MESSAGE, - number=3, - oneof='languages', - message=LanguageCodePair, - ) - language_codes_set: LanguageCodesSet = proto.Field( - proto.MESSAGE, - number=4, - oneof='languages', - message=LanguageCodesSet, - ) - input_config: 'GlossaryInputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='GlossaryInputConfig', - ) - entry_count: int = proto.Field( - proto.INT32, - number=6, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=7, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=8, - message=timestamp_pb2.Timestamp, - ) - display_name: str = proto.Field( - proto.STRING, - number=9, - ) - - -class CreateGlossaryRequest(proto.Message): - r"""Request message for CreateGlossary. - - Attributes: - parent (str): - Required. The project name. - glossary (google.cloud.translate_v3.types.Glossary): - Required. The glossary to create. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - glossary: 'Glossary' = proto.Field( - proto.MESSAGE, - number=2, - message='Glossary', - ) - - -class GetGlossaryRequest(proto.Message): - r"""Request message for GetGlossary. - - Attributes: - name (str): - Required. The name of the glossary to - retrieve. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteGlossaryRequest(proto.Message): - r"""Request message for DeleteGlossary. - - Attributes: - name (str): - Required. The name of the glossary to delete. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ListGlossariesRequest(proto.Message): - r"""Request message for ListGlossaries. - - Attributes: - parent (str): - Required. The name of the project from which - to list all of the glossaries. - page_size (int): - Optional. Requested page size. The server may - return fewer glossaries than requested. If - unspecified, the server picks an appropriate - default. - page_token (str): - Optional. A token identifying a page of results the server - should return. Typically, this is the value of - [ListGlossariesResponse.next_page_token] returned from the - previous call to ``ListGlossaries`` method. The first page - is returned if ``page_token``\ is empty or missing. - filter (str): - Optional. Filter specifying constraints of a - list operation. Specify the constraint by the - format of "key=value", where key must be "src" - or "tgt", and the value must be a valid language - code. For multiple restrictions, concatenate - them by "AND" (uppercase only), such as: - "src=en-US AND tgt=zh-CN". Notice that the exact - match is used here, which means using 'en-US' - and 'en' can lead to different results, which - depends on the language code you used when you - create the glossary. For the unidirectional - glossaries, the "src" and "tgt" add restrictions - on the source and target language code - separately. For the equivalent term set - glossaries, the "src" and/or "tgt" add - restrictions on the term set. - For example: "src=en-US AND tgt=zh-CN" will only - pick the unidirectional glossaries which exactly - match the source language code as "en-US" and - the target language code "zh-CN", but all - equivalent term set glossaries which contain - "en-US" and "zh-CN" in their language set will - be picked. If missing, no filtering is - performed. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - filter: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListGlossariesResponse(proto.Message): - r"""Response message for ListGlossaries. - - Attributes: - glossaries (MutableSequence[google.cloud.translate_v3.types.Glossary]): - The list of glossaries for a project. - next_page_token (str): - A token to retrieve a page of results. Pass this value in - the [ListGlossariesRequest.page_token] field in the - subsequent call to ``ListGlossaries`` method to retrieve the - next page of results. - """ - - @property - def raw_page(self): - return self - - glossaries: MutableSequence['Glossary'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Glossary', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class CreateGlossaryMetadata(proto.Message): - r"""Stored in the - [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] - field returned by CreateGlossary. - - Attributes: - name (str): - The name of the glossary that is being - created. - state (google.cloud.translate_v3.types.CreateGlossaryMetadata.State): - The current state of the glossary creation - operation. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - """ - class State(proto.Enum): - r"""Enumerates the possible states that the creation request can - be in. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The glossary was successfully created. - FAILED (3): - Failed to create the glossary. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The glossary creation request was - successfully canceled. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - state: State = proto.Field( - proto.ENUM, - number=2, - enum=State, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class DeleteGlossaryMetadata(proto.Message): - r"""Stored in the - [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] - field returned by DeleteGlossary. - - Attributes: - name (str): - The name of the glossary that is being - deleted. - state (google.cloud.translate_v3.types.DeleteGlossaryMetadata.State): - The current state of the glossary deletion - operation. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - """ - class State(proto.Enum): - r"""Enumerates the possible states that the creation request can - be in. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The glossary was successfully deleted. - FAILED (3): - Failed to delete the glossary. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The glossary deletion request was - successfully canceled. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - state: State = proto.Field( - proto.ENUM, - number=2, - enum=State, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class DeleteGlossaryResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - Attributes: - name (str): - The name of the deleted glossary. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the glossary deletion is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateDocumentRequest(proto.Message): - r"""The BatchTranslateDocument request. - - Attributes: - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the same - region (have the same location-id) can be used, otherwise an - INVALID_ARGUMENT (400) error is returned. - source_language_code (str): - Required. The ISO-639 language code of the input document if - known, for example, "en-US" or "sr-Latn". Supported language - codes are listed in `Language - Support `__. - target_language_codes (MutableSequence[str]): - Required. The ISO-639 language code to use - for translation of the input document. Specify - up to 10 language codes here. - input_configs (MutableSequence[google.cloud.translate_v3.types.BatchDocumentInputConfig]): - Required. Input configurations. - The total number of files matched should be <= - 100. The total content size to translate should - be <= 100M Unicode codepoints. The files must - use UTF-8 encoding. - output_config (google.cloud.translate_v3.types.BatchDocumentOutputConfig): - Required. Output configuration. - If 2 input configs match to the same file (that - is, same input path), we don't generate output - for duplicate inputs. - models (MutableMapping[str, str]): - Optional. The models to use for translation. Map's key is - target language code. Map's value is the model name. Value - can be a built-in general model, or an AutoML Translation - model. - - The value format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If the map is empty or a specific model is not requested for - a language pair, then default google model (nmt) is used. - glossaries (MutableMapping[str, google.cloud.translate_v3.types.TranslateTextGlossaryConfig]): - Optional. Glossaries to be applied. It's - keyed by target language code. - format_conversions (MutableMapping[str, str]): - Optional. File format conversion map to be applied to all - input files. Map's key is the original mime_type. Map's - value is the target mime_type of translated documents. - - Supported file format conversion includes: - - - ``application/pdf`` to - ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` - - If nothing specified, output files will be in the same - format as the original file. - customized_attribution (str): - Optional. This flag is to support user customized - attribution. If not provided, the default is - ``Machine Translated by Google``. Customized attribution - should follow rules in - https://cloud.google.com/translate/attribution#attribution_and_logos - enable_shadow_removal_native_pdf (bool): - Optional. If true, use the text removal server to remove the - shadow text on background image for native pdf translation. - Shadow removal feature can only be enabled when - is_translate_native_pdf_only: false && pdf_native_only: - false - enable_rotation_correction (bool): - Optional. If true, enable auto rotation - correction in DVS. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - input_configs: MutableSequence['BatchDocumentInputConfig'] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message='BatchDocumentInputConfig', - ) - output_config: 'BatchDocumentOutputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='BatchDocumentOutputConfig', - ) - models: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - glossaries: MutableMapping[str, 'TranslateTextGlossaryConfig'] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - format_conversions: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=8, - ) - customized_attribution: str = proto.Field( - proto.STRING, - number=10, - ) - enable_shadow_removal_native_pdf: bool = proto.Field( - proto.BOOL, - number=11, - ) - enable_rotation_correction: bool = proto.Field( - proto.BOOL, - number=12, - ) - - -class BatchDocumentInputConfig(proto.Message): - r"""Input configuration for BatchTranslateDocument request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_source (google.cloud.translate_v3.types.GcsSource): - Google Cloud Storage location for the source input. This can - be a single file (for example, - ``gs://translation-test/input.docx``) or a wildcard (for - example, ``gs://translation-test/*``). - - File mime type is determined based on extension. Supported - mime type includes: - - - ``pdf``, application/pdf - - ``docx``, - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - ``pptx``, - application/vnd.openxmlformats-officedocument.presentationml.presentation - - ``xlsx``, - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - The max file size to support for ``.docx``, ``.pptx`` and - ``.xlsx`` is 100MB. The max file size to support for - ``.pdf`` is 1GB and the max page limit is 1000 pages. The - max file size to support for all input documents is 1GB. - - This field is a member of `oneof`_ ``source``. - """ - - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=1, - oneof='source', - message='GcsSource', - ) - - -class BatchDocumentOutputConfig(proto.Message): - r"""Output configuration for BatchTranslateDocument request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3.types.GcsDestination): - Google Cloud Storage destination for output content. For - every single input document (for example, - gs://a/b/c.[extension]), we generate at most 2 \* n output - files. (n is the # of target_language_codes in the - BatchTranslateDocumentRequest). - - While the input documents are being processed, we - write/update an index file ``index.csv`` under - ``gcs_destination.output_uri_prefix`` (for example, - gs://translation_output/index.csv) The index file is - generated/updated as new files are being translated. The - format is: - - input_document,target_language_code,translation_output,error_output, - glossary_translation_output,glossary_error_output - - ``input_document`` is one file we matched using - gcs_source.input_uri. ``target_language_code`` is provided - in the request. ``translation_output`` contains the - translations. (details provided below) ``error_output`` - contains the error message during processing of the file. - Both translations_file and errors_file could be empty - strings if we have no content to output. - ``glossary_translation_output`` and - ``glossary_error_output`` are the translated output/error - when we apply glossaries. They could also be empty if we - have no content to output. - - Once a row is present in index.csv, the input/output - matching never changes. Callers should also expect all the - content in input_file are processed and ready to be consumed - (that is, no partial output file is written). - - Since index.csv will be keeping updated during the process, - please make sure there is no custom retention policy applied - on the output bucket that may avoid file updating. - (https://cloud.google.com/storage/docs/bucket-lock#retention-policy) - - The naming format of translation output files follows (for - target language code [trg]): ``translation_output``: - ``gs://translation_output/a_b_c_[trg]_translation.[extension]`` - ``glossary_translation_output``: - ``gs://translation_test/a_b_c_[trg]_glossary_translation.[extension]``. - The output document will maintain the same file format as - the input document. - - The naming format of error output files follows (for target - language code [trg]): ``error_output``: - ``gs://translation_test/a_b_c_[trg]_errors.txt`` - ``glossary_error_output``: - ``gs://translation_test/a_b_c_[trg]_glossary_translation.txt``. - The error output is a txt file containing error details. - - This field is a member of `oneof`_ ``destination``. - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - - -class BatchTranslateDocumentResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least one document is - translated successfully. - - Attributes: - total_pages (int): - Total number of pages to translate in all - documents. Documents without clear page - definition (such as XLSX) are not counted. - translated_pages (int): - Number of successfully translated pages in - all documents. Documents without clear page - definition (such as XLSX) are not counted. - failed_pages (int): - Number of pages that failed to process in all - documents. Documents without clear page - definition (such as XLSX) are not counted. - total_billable_pages (int): - Number of billable pages in documents with - clear page definition (such as PDF, DOCX, PPTX) - total_characters (int): - Total number of characters (Unicode - codepoints) in all documents. - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints) in all documents. - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints) in all documents. - total_billable_characters (int): - Number of billable characters (Unicode - codepoints) in documents without clear page - definition, such as XLSX. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - total_pages: int = proto.Field( - proto.INT64, - number=1, - ) - translated_pages: int = proto.Field( - proto.INT64, - number=2, - ) - failed_pages: int = proto.Field( - proto.INT64, - number=3, - ) - total_billable_pages: int = proto.Field( - proto.INT64, - number=4, - ) - total_characters: int = proto.Field( - proto.INT64, - number=5, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=6, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=7, - ) - total_billable_characters: int = proto.Field( - proto.INT64, - number=8, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=10, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateDocumentMetadata(proto.Message): - r"""State metadata for the batch translation operation. - - Attributes: - state (google.cloud.translate_v3.types.BatchTranslateDocumentMetadata.State): - The state of the operation. - total_pages (int): - Total number of pages to translate in all - documents so far. Documents without clear page - definition (such as XLSX) are not counted. - translated_pages (int): - Number of successfully translated pages in - all documents so far. Documents without clear - page definition (such as XLSX) are not counted. - failed_pages (int): - Number of pages that failed to process in all - documents so far. Documents without clear page - definition (such as XLSX) are not counted. - total_billable_pages (int): - Number of billable pages in documents with - clear page definition (such as PDF, DOCX, PPTX) - so far. - total_characters (int): - Total number of characters (Unicode - codepoints) in all documents so far. - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints) in all documents so far. - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints) in all documents so - far. - total_billable_characters (int): - Number of billable characters (Unicode - codepoints) in documents without clear page - definition (such as XLSX) so far. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - """ - class State(proto.Enum): - r"""State of the job. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The batch is processed, and at least one item - was successfully processed. - FAILED (3): - The batch is done and no item was - successfully processed. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The batch is done after the user has called - the longrunning.Operations.CancelOperation. Any - records processed before the cancel command are - output as specified in the request. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - state: State = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - total_pages: int = proto.Field( - proto.INT64, - number=2, - ) - translated_pages: int = proto.Field( - proto.INT64, - number=3, - ) - failed_pages: int = proto.Field( - proto.INT64, - number=4, - ) - total_billable_pages: int = proto.Field( - proto.INT64, - number=5, - ) - total_characters: int = proto.Field( - proto.INT64, - number=6, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=7, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=8, - ) - total_billable_characters: int = proto.Field( - proto.INT64, - number=9, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=10, - message=timestamp_pb2.Timestamp, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v3/mypy.ini b/owl-bot-staging/v3/mypy.ini deleted file mode 100644 index 574c5aed..00000000 --- a/owl-bot-staging/v3/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v3/noxfile.py b/owl-bot-staging/v3/noxfile.py deleted file mode 100644 index 417d8120..00000000 --- a/owl-bot-staging/v3/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/translate_v3/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - '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 docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==7.0.1", "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=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", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v3/samples/generated_samples/snippet_metadata_google.cloud.translation.v3.json b/owl-bot-staging/v3/samples/generated_samples/snippet_metadata_google.cloud.translation.v3.json deleted file mode 100644 index cb3dc3b1..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/snippet_metadata_google.cloud.translation.v3.json +++ /dev/null @@ -1,1729 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.translation.v3", - "version": "v3" - } - ], - "language": "PYTHON", - "name": "google-cloud-translate", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.batch_translate_document", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.BatchTranslateDocumentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "target_language_codes", - "type": "MutableSequence[str]" - }, - { - "name": "input_configs", - "type": "MutableSequence[google.cloud.translate_v3.types.BatchDocumentInputConfig]" - }, - { - "name": "output_config", - "type": "google.cloud.translate_v3.types.BatchDocumentOutputConfig" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "batch_translate_document" - }, - "description": "Sample for BatchTranslateDocument", - "file": "translate_v3_generated_translation_service_batch_translate_document_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_BatchTranslateDocument_async", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_batch_translate_document_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.batch_translate_document", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.BatchTranslateDocumentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "target_language_codes", - "type": "MutableSequence[str]" - }, - { - "name": "input_configs", - "type": "MutableSequence[google.cloud.translate_v3.types.BatchDocumentInputConfig]" - }, - { - "name": "output_config", - "type": "google.cloud.translate_v3.types.BatchDocumentOutputConfig" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "batch_translate_document" - }, - "description": "Sample for BatchTranslateDocument", - "file": "translate_v3_generated_translation_service_batch_translate_document_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_BatchTranslateDocument_sync", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_batch_translate_document_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.batch_translate_text", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateText", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.BatchTranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "batch_translate_text" - }, - "description": "Sample for BatchTranslateText", - "file": "translate_v3_generated_translation_service_batch_translate_text_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_BatchTranslateText_async", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_batch_translate_text_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.batch_translate_text", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.BatchTranslateText", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.BatchTranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "batch_translate_text" - }, - "description": "Sample for BatchTranslateText", - "file": "translate_v3_generated_translation_service_batch_translate_text_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_BatchTranslateText_sync", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_batch_translate_text_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.create_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.CreateGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "CreateGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.CreateGlossaryRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "glossary", - "type": "google.cloud.translate_v3.types.Glossary" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "create_glossary" - }, - "description": "Sample for CreateGlossary", - "file": "translate_v3_generated_translation_service_create_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_CreateGlossary_async", - "segments": [ - { - "end": 59, - "start": 27, - "type": "FULL" - }, - { - "end": 59, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 56, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 60, - "start": 57, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_create_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.create_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.CreateGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "CreateGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.CreateGlossaryRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "glossary", - "type": "google.cloud.translate_v3.types.Glossary" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "create_glossary" - }, - "description": "Sample for CreateGlossary", - "file": "translate_v3_generated_translation_service_create_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_CreateGlossary_sync", - "segments": [ - { - "end": 59, - "start": 27, - "type": "FULL" - }, - { - "end": 59, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 56, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 60, - "start": 57, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_create_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.delete_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.DeleteGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DeleteGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.DeleteGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "delete_glossary" - }, - "description": "Sample for DeleteGlossary", - "file": "translate_v3_generated_translation_service_delete_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_DeleteGlossary_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_delete_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.delete_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.DeleteGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DeleteGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.DeleteGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "delete_glossary" - }, - "description": "Sample for DeleteGlossary", - "file": "translate_v3_generated_translation_service_delete_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_DeleteGlossary_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_delete_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.detect_language", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.DetectLanguage", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DetectLanguage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.DetectLanguageRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "content", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.DetectLanguageResponse", - "shortName": "detect_language" - }, - "description": "Sample for DetectLanguage", - "file": "translate_v3_generated_translation_service_detect_language_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_DetectLanguage_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_detect_language_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.detect_language", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.DetectLanguage", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DetectLanguage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.DetectLanguageRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "content", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.DetectLanguageResponse", - "shortName": "detect_language" - }, - "description": "Sample for DetectLanguage", - "file": "translate_v3_generated_translation_service_detect_language_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_DetectLanguage_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_detect_language_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.get_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.GetGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.GetGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.Glossary", - "shortName": "get_glossary" - }, - "description": "Sample for GetGlossary", - "file": "translate_v3_generated_translation_service_get_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_GetGlossary_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_get_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.get_glossary", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.GetGlossary", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.GetGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.Glossary", - "shortName": "get_glossary" - }, - "description": "Sample for GetGlossary", - "file": "translate_v3_generated_translation_service_get_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_GetGlossary_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_get_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.get_supported_languages", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.GetSupportedLanguages", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetSupportedLanguages" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.GetSupportedLanguagesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "display_language_code", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.SupportedLanguages", - "shortName": "get_supported_languages" - }, - "description": "Sample for GetSupportedLanguages", - "file": "translate_v3_generated_translation_service_get_supported_languages_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_GetSupportedLanguages_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_get_supported_languages_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.get_supported_languages", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.GetSupportedLanguages", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetSupportedLanguages" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.GetSupportedLanguagesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "display_language_code", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.SupportedLanguages", - "shortName": "get_supported_languages" - }, - "description": "Sample for GetSupportedLanguages", - "file": "translate_v3_generated_translation_service_get_supported_languages_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_GetSupportedLanguages_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_get_supported_languages_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.list_glossaries", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.ListGlossaries", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "ListGlossaries" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.ListGlossariesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.services.translation_service.pagers.ListGlossariesAsyncPager", - "shortName": "list_glossaries" - }, - "description": "Sample for ListGlossaries", - "file": "translate_v3_generated_translation_service_list_glossaries_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_ListGlossaries_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_list_glossaries_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.list_glossaries", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.ListGlossaries", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "ListGlossaries" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.ListGlossariesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.services.translation_service.pagers.ListGlossariesPager", - "shortName": "list_glossaries" - }, - "description": "Sample for ListGlossaries", - "file": "translate_v3_generated_translation_service_list_glossaries_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_ListGlossaries_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_list_glossaries_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.translate_document", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.TranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.TranslateDocumentRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.TranslateDocumentResponse", - "shortName": "translate_document" - }, - "description": "Sample for TranslateDocument", - "file": "translate_v3_generated_translation_service_translate_document_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_TranslateDocument_async", - "segments": [ - { - "end": 56, - "start": 27, - "type": "FULL" - }, - { - "end": 56, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 50, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 53, - "start": 51, - "type": "REQUEST_EXECUTION" - }, - { - "end": 57, - "start": 54, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_translate_document_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.translate_document", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.TranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.TranslateDocumentRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.TranslateDocumentResponse", - "shortName": "translate_document" - }, - "description": "Sample for TranslateDocument", - "file": "translate_v3_generated_translation_service_translate_document_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_TranslateDocument_sync", - "segments": [ - { - "end": 56, - "start": 27, - "type": "FULL" - }, - { - "end": 56, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 50, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 53, - "start": 51, - "type": "REQUEST_EXECUTION" - }, - { - "end": 57, - "start": 54, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_translate_document_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceAsyncClient.translate_text", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.TranslateText", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.TranslateTextRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "target_language_code", - "type": "str" - }, - { - "name": "contents", - "type": "MutableSequence[str]" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.TranslateTextResponse", - "shortName": "translate_text" - }, - "description": "Sample for TranslateText", - "file": "translate_v3_generated_translation_service_translate_text_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_TranslateText_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_translate_text_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3.TranslationServiceClient.translate_text", - "method": { - "fullName": "google.cloud.translation.v3.TranslationService.TranslateText", - "service": { - "fullName": "google.cloud.translation.v3.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3.types.TranslateTextRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "target_language_code", - "type": "str" - }, - { - "name": "contents", - "type": "MutableSequence[str]" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3.types.TranslateTextResponse", - "shortName": "translate_text" - }, - "description": "Sample for TranslateText", - "file": "translate_v3_generated_translation_service_translate_text_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3_generated_TranslationService_TranslateText_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3_generated_translation_service_translate_text_sync.py" - } - ] -} diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_async.py deleted file mode 100644 index 7a148ae9..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_async.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateDocument -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_BatchTranslateDocument_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.cloud import translate_v3 - - -async def sample_batch_translate_document(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_BatchTranslateDocument_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_sync.py deleted file mode 100644 index fa3e2e92..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_document_sync.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateDocument -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_BatchTranslateDocument_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.cloud import translate_v3 - - -def sample_batch_translate_document(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_BatchTranslateDocument_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_async.py deleted file mode 100644 index eaf75263..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_async.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateText -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_BatchTranslateText_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.cloud import translate_v3 - - -async def sample_batch_translate_text(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_BatchTranslateText_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_sync.py deleted file mode 100644 index 25aa490e..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_batch_translate_text_sync.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateText -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_BatchTranslateText_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.cloud import translate_v3 - - -def sample_batch_translate_text(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_BatchTranslateText_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_async.py deleted file mode 100644 index d15165f5..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_async.py +++ /dev/null @@ -1,60 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 CreateGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_CreateGlossary_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.cloud import translate_v3 - - -async def sample_create_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - glossary = translate_v3.Glossary() - glossary.name = "name_value" - - request = translate_v3.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_CreateGlossary_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_sync.py deleted file mode 100644 index 90b58206..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_create_glossary_sync.py +++ /dev/null @@ -1,60 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 CreateGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_CreateGlossary_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.cloud import translate_v3 - - -def sample_create_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - glossary = translate_v3.Glossary() - glossary.name = "name_value" - - request = translate_v3.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_CreateGlossary_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_async.py deleted file mode 100644 index ec5710c1..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DeleteGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_DeleteGlossary_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.cloud import translate_v3 - - -async def sample_delete_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_DeleteGlossary_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_sync.py deleted file mode 100644 index a239d230..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_delete_glossary_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DeleteGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_DeleteGlossary_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.cloud import translate_v3 - - -def sample_delete_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_DeleteGlossary_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_async.py deleted file mode 100644 index 02895278..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DetectLanguage -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_DetectLanguage_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.cloud import translate_v3 - - -async def sample_detect_language(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = await client.detect_language(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_DetectLanguage_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_sync.py deleted file mode 100644 index 2a02434d..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_detect_language_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DetectLanguage -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_DetectLanguage_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.cloud import translate_v3 - - -def sample_detect_language(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = client.detect_language(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_DetectLanguage_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_async.py deleted file mode 100644 index e25bb25e..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_GetGlossary_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.cloud import translate_v3 - - -async def sample_get_glossary(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = await client.get_glossary(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_GetGlossary_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_sync.py deleted file mode 100644 index 521273a2..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_glossary_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetGlossary -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_GetGlossary_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.cloud import translate_v3 - - -def sample_get_glossary(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = client.get_glossary(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_GetGlossary_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_async.py deleted file mode 100644 index 417f51b0..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetSupportedLanguages -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_GetSupportedLanguages_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.cloud import translate_v3 - - -async def sample_get_supported_languages(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = await client.get_supported_languages(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_GetSupportedLanguages_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_sync.py deleted file mode 100644 index 783be2da..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_get_supported_languages_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetSupportedLanguages -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_GetSupportedLanguages_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.cloud import translate_v3 - - -def sample_get_supported_languages(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = client.get_supported_languages(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_GetSupportedLanguages_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_async.py deleted file mode 100644 index 06dcd675..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 ListGlossaries -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_ListGlossaries_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.cloud import translate_v3 - - -async def sample_list_glossaries(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END translate_v3_generated_TranslationService_ListGlossaries_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_sync.py deleted file mode 100644 index 172fd9e7..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_list_glossaries_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 ListGlossaries -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_ListGlossaries_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.cloud import translate_v3 - - -def sample_list_glossaries(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END translate_v3_generated_TranslationService_ListGlossaries_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_async.py deleted file mode 100644 index d02a4eb8..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_async.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateDocument -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_TranslateDocument_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.cloud import translate_v3 - - -async def sample_translate_document(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - document_input_config = translate_v3.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = await client.translate_document(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_TranslateDocument_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_sync.py deleted file mode 100644 index 3713ca0f..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_document_sync.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateDocument -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_TranslateDocument_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.cloud import translate_v3 - - -def sample_translate_document(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - document_input_config = translate_v3.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = client.translate_document(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_TranslateDocument_sync] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_async.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_async.py deleted file mode 100644 index ada193db..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateText -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_TranslateText_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.cloud import translate_v3 - - -async def sample_translate_text(): - # Create a client - client = translate_v3.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = await client.translate_text(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_TranslateText_async] diff --git a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_sync.py b/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_sync.py deleted file mode 100644 index ff9d0bad..00000000 --- a/owl-bot-staging/v3/samples/generated_samples/translate_v3_generated_translation_service_translate_text_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateText -# 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-cloud-translate - - -# [START translate_v3_generated_TranslationService_TranslateText_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.cloud import translate_v3 - - -def sample_translate_text(): - # Create a client - client = translate_v3.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = client.translate_text(request=request) - - # Handle the response - print(response) - -# [END translate_v3_generated_TranslationService_TranslateText_sync] diff --git a/owl-bot-staging/v3/scripts/fixup_translate_v3_keywords.py b/owl-bot-staging/v3/scripts/fixup_translate_v3_keywords.py deleted file mode 100644 index ef488ce1..00000000 --- a/owl-bot-staging/v3/scripts/fixup_translate_v3_keywords.py +++ /dev/null @@ -1,185 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2023 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 translateCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'batch_translate_document': ('parent', 'source_language_code', 'target_language_codes', 'input_configs', 'output_config', 'models', 'glossaries', 'format_conversions', 'customized_attribution', 'enable_shadow_removal_native_pdf', 'enable_rotation_correction', ), - 'batch_translate_text': ('parent', 'source_language_code', 'target_language_codes', 'input_configs', 'output_config', 'models', 'glossaries', 'labels', ), - 'create_glossary': ('parent', 'glossary', ), - 'delete_glossary': ('name', ), - 'detect_language': ('parent', 'model', 'content', 'mime_type', 'labels', ), - 'get_glossary': ('name', ), - 'get_supported_languages': ('parent', 'display_language_code', 'model', ), - 'list_glossaries': ('parent', 'page_size', 'page_token', 'filter', ), - 'translate_document': ('parent', 'target_language_code', 'document_input_config', 'source_language_code', 'document_output_config', 'model', 'glossary_config', 'labels', 'customized_attribution', 'is_translate_native_pdf_only', 'enable_shadow_removal_native_pdf', 'enable_rotation_correction', ), - 'translate_text': ('contents', 'target_language_code', 'parent', 'mime_type', 'source_language_code', 'model', 'glossary_config', 'labels', ), - } - - 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=translateCallTransformer(), -): - """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 translate 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/v3/setup.py b/owl-bot-staging/v3/setup.py deleted file mode 100644 index b5127264..00000000 --- a/owl-bot-staging/v3/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-translate' - - -description = "Google Cloud Translate API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/translate/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -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.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-translate" - -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.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -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", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v3/testing/constraints-3.10.txt b/owl-bot-staging/v3/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3/testing/constraints-3.11.txt b/owl-bot-staging/v3/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3/testing/constraints-3.12.txt b/owl-bot-staging/v3/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3/testing/constraints-3.7.txt b/owl-bot-staging/v3/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adfe..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +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.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v3/testing/constraints-3.8.txt b/owl-bot-staging/v3/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3/testing/constraints-3.9.txt b/owl-bot-staging/v3/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3/tests/__init__.py b/owl-bot-staging/v3/tests/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/tests/unit/__init__.py b/owl-bot-staging/v3/tests/unit/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/tests/unit/gapic/__init__.py b/owl-bot-staging/v3/tests/unit/gapic/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/tests/unit/gapic/translate_v3/__init__.py b/owl-bot-staging/v3/tests/unit/gapic/translate_v3/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3/tests/unit/gapic/translate_v3/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3/tests/unit/gapic/translate_v3/test_translation_service.py b/owl-bot-staging/v3/tests/unit/gapic/translate_v3/test_translation_service.py deleted file mode 100644 index 014f4255..00000000 --- a/owl-bot-staging/v3/tests/unit/gapic/translate_v3/test_translation_service.py +++ /dev/null @@ -1,6204 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -from google.protobuf import json_format -import json -import math -import pytest -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 - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import future -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 operation -from google.api_core import operation_async # type: ignore -from google.api_core import operations_v1 -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.translate_v3.services.translation_service import TranslationServiceAsyncClient -from google.cloud.translate_v3.services.translation_service import TranslationServiceClient -from google.cloud.translate_v3.services.translation_service import pagers -from google.cloud.translate_v3.services.translation_service import transports -from google.cloud.translate_v3.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# 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 - - -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 TranslationServiceClient._get_default_mtls_endpoint(None) is None - assert TranslationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (TranslationServiceClient, "grpc"), - (TranslationServiceAsyncClient, "grpc_asyncio"), - (TranslationServiceClient, "rest"), -]) -def test_translation_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 == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://translate.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.TranslationServiceGrpcTransport, "grpc"), - (transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.TranslationServiceRestTransport, "rest"), -]) -def test_translation_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", [ - (TranslationServiceClient, "grpc"), - (TranslationServiceAsyncClient, "grpc_asyncio"), - (TranslationServiceClient, "rest"), -]) -def test_translation_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 == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://translate.googleapis.com' - ) - - -def test_translation_service_client_get_transport_class(): - transport = TranslationServiceClient.get_transport_class() - available_transports = [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceRestTransport, - ] - assert transport in available_transports - - transport = TranslationServiceClient.get_transport_class("grpc") - assert transport == transports.TranslationServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest"), -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -def test_translation_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(TranslationServiceClient, '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(TranslationServiceClient, '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, - 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): - client = client_class(transport=transport_name) - - # 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): - client = client_class(transport=transport_name) - - # 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, - 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, - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", "true"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", "false"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", "true"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_translation_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 - 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 - 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, - 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", [ - TranslationServiceClient, TranslationServiceAsyncClient -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -def test_translation_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 - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest"), -]) -def test_translation_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, - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", grpc_helpers), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", None), -]) -def test_translation_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, - 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_translation_service_client_client_options_from_dict(): - with mock.patch('google.cloud.translate_v3.services.translation_service.transports.TranslationServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = TranslationServiceClient( - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", grpc_helpers), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_translation_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, - 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( - "translate.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - scopes=None, - default_host="translate.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateTextRequest, - dict, -]) -def test_translate_text(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateTextResponse( - ) - response = client.translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -def test_translate_text_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - client.translate_text() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - -@pytest.mark.asyncio -async def test_translate_text_async(transport: str = 'grpc_asyncio', request_type=translation_service.TranslateTextRequest): - client = TranslationServiceAsyncClient( - 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.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateTextResponse( - )) - response = await client.translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -@pytest.mark.asyncio -async def test_translate_text_async_from_dict(): - await test_translate_text_async(request_type=dict) - - -def test_translate_text_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.TranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - call.return_value = translation_service.TranslateTextResponse() - client.translate_text(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_translate_text_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.TranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateTextResponse()) - await client.translate_text(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_translate_text_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateTextResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.translate_text( - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_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].target_language_code - mock_val = 'target_language_code_value' - assert arg == mock_val - arg = args[0].contents - mock_val = ['contents_value'] - assert arg == mock_val - arg = args[0].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - arg = args[0].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - - -def test_translate_text_flattened_error(): - client = TranslationServiceClient( - 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.translate_text( - translation_service.TranslateTextRequest(), - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_value', - ) - -@pytest.mark.asyncio -async def test_translate_text_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateTextResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateTextResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.translate_text( - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_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].target_language_code - mock_val = 'target_language_code_value' - assert arg == mock_val - arg = args[0].contents - mock_val = ['contents_value'] - assert arg == mock_val - arg = args[0].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - arg = args[0].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_translate_text_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.translate_text( - translation_service.TranslateTextRequest(), - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DetectLanguageRequest, - dict, -]) -def test_detect_language(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse( - ) - response = client.detect_language(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -def test_detect_language_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - client.detect_language() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - -@pytest.mark.asyncio -async def test_detect_language_async(transport: str = 'grpc_asyncio', request_type=translation_service.DetectLanguageRequest): - client = TranslationServiceAsyncClient( - 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.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse( - )) - response = await client.detect_language(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -@pytest.mark.asyncio -async def test_detect_language_async_from_dict(): - await test_detect_language_async(request_type=dict) - - -def test_detect_language_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.DetectLanguageRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - call.return_value = translation_service.DetectLanguageResponse() - client.detect_language(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_detect_language_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.DetectLanguageRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse()) - await client.detect_language(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_detect_language_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.detect_language( - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - content='content_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - assert args[0].content == 'content_value' - - -def test_detect_language_flattened_error(): - client = TranslationServiceClient( - 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.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - content='content_value', - ) - -@pytest.mark.asyncio -async def test_detect_language_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.detect_language( - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - content='content_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - assert args[0].content == 'content_value' - -@pytest.mark.asyncio -async def test_detect_language_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - content='content_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetSupportedLanguagesRequest, - dict, -]) -def test_get_supported_languages(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages( - ) - response = client.get_supported_languages(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -def test_get_supported_languages_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - client.get_supported_languages() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - -@pytest.mark.asyncio -async def test_get_supported_languages_async(transport: str = 'grpc_asyncio', request_type=translation_service.GetSupportedLanguagesRequest): - client = TranslationServiceAsyncClient( - 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.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages( - )) - response = await client.get_supported_languages(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -@pytest.mark.asyncio -async def test_get_supported_languages_async_from_dict(): - await test_get_supported_languages_async(request_type=dict) - - -def test_get_supported_languages_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.GetSupportedLanguagesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - call.return_value = translation_service.SupportedLanguages() - client.get_supported_languages(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_get_supported_languages_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.GetSupportedLanguagesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages()) - await client.get_supported_languages(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_get_supported_languages_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_supported_languages( - parent='parent_value', - model='model_value', - display_language_code='display_language_code_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].display_language_code - mock_val = 'display_language_code_value' - assert arg == mock_val - - -def test_get_supported_languages_flattened_error(): - client = TranslationServiceClient( - 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.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - model='model_value', - display_language_code='display_language_code_value', - ) - -@pytest.mark.asyncio -async def test_get_supported_languages_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_supported_languages( - parent='parent_value', - model='model_value', - display_language_code='display_language_code_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].display_language_code - mock_val = 'display_language_code_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_supported_languages_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - model='model_value', - display_language_code='display_language_code_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateDocumentRequest, - dict, -]) -def test_translate_document(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateDocumentResponse( - model='model_value', - ) - response = client.translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -def test_translate_document_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - client.translate_document() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - -@pytest.mark.asyncio -async def test_translate_document_async(transport: str = 'grpc_asyncio', request_type=translation_service.TranslateDocumentRequest): - client = TranslationServiceAsyncClient( - 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.translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateDocumentResponse( - model='model_value', - )) - response = await client.translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -@pytest.mark.asyncio -async def test_translate_document_async_from_dict(): - await test_translate_document_async(request_type=dict) - - -def test_translate_document_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.TranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - call.return_value = translation_service.TranslateDocumentResponse() - client.translate_document(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_translate_document_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.TranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateDocumentResponse()) - await client.translate_document(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'] - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateTextRequest, - dict, -]) -def test_batch_translate_text(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.batch_translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.batch_translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_batch_translate_text_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - client.batch_translate_text() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - -@pytest.mark.asyncio -async def test_batch_translate_text_async(transport: str = 'grpc_asyncio', request_type=translation_service.BatchTranslateTextRequest): - client = TranslationServiceAsyncClient( - 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.batch_translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.batch_translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_batch_translate_text_async_from_dict(): - await test_batch_translate_text_async(request_type=dict) - - -def test_batch_translate_text_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.BatchTranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.batch_translate_text(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_batch_translate_text_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.BatchTranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.batch_translate_text(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'] - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateDocumentRequest, - dict, -]) -def test_batch_translate_document(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.batch_translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_batch_translate_document_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - client.batch_translate_document() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - -@pytest.mark.asyncio -async def test_batch_translate_document_async(transport: str = 'grpc_asyncio', request_type=translation_service.BatchTranslateDocumentRequest): - client = TranslationServiceAsyncClient( - 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.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.batch_translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_batch_translate_document_async_from_dict(): - await test_batch_translate_document_async(request_type=dict) - - -def test_batch_translate_document_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.BatchTranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.batch_translate_document(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_batch_translate_document_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.BatchTranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.batch_translate_document(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_batch_translate_document_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.batch_translate_document( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_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].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - arg = args[0].target_language_codes - mock_val = ['target_language_codes_value'] - assert arg == mock_val - arg = args[0].input_configs - mock_val = [translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))] - assert arg == mock_val - arg = args[0].output_config - mock_val = translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')) - assert arg == mock_val - - -def test_batch_translate_document_flattened_error(): - client = TranslationServiceClient( - 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.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - -@pytest.mark.asyncio -async def test_batch_translate_document_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.batch_translate_document( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_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].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - arg = args[0].target_language_codes - mock_val = ['target_language_codes_value'] - assert arg == mock_val - arg = args[0].input_configs - mock_val = [translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))] - assert arg == mock_val - arg = args[0].output_config - mock_val = translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')) - assert arg == mock_val - -@pytest.mark.asyncio -async def test_batch_translate_document_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.CreateGlossaryRequest, - dict, -]) -def test_create_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.create_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_create_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - client.create_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - -@pytest.mark.asyncio -async def test_create_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.CreateGlossaryRequest): - client = TranslationServiceAsyncClient( - 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_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.create_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_create_glossary_async_from_dict(): - await test_create_glossary_async(request_type=dict) - - -def test_create_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.CreateGlossaryRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.create_glossary(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_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.CreateGlossaryRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.create_glossary(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_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_glossary( - parent='parent_value', - glossary=translation_service.Glossary(name='name_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].glossary - mock_val = translation_service.Glossary(name='name_value') - assert arg == mock_val - - -def test_create_glossary_flattened_error(): - client = TranslationServiceClient( - 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_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_glossary( - parent='parent_value', - glossary=translation_service.Glossary(name='name_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].glossary - mock_val = translation_service.Glossary(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.ListGlossariesRequest, - dict, -]) -def test_list_glossaries(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - ) - response = client.list_glossaries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_glossaries_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - client.list_glossaries() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - -@pytest.mark.asyncio -async def test_list_glossaries_async(transport: str = 'grpc_asyncio', request_type=translation_service.ListGlossariesRequest): - client = TranslationServiceAsyncClient( - 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.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_glossaries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_glossaries_async_from_dict(): - await test_list_glossaries_async(request_type=dict) - - -def test_list_glossaries_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.ListGlossariesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - call.return_value = translation_service.ListGlossariesResponse() - client.list_glossaries(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_list_glossaries_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.ListGlossariesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse()) - await client.list_glossaries(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_list_glossaries_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_glossaries( - parent='parent_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 - - -def test_list_glossaries_flattened_error(): - client = TranslationServiceClient( - 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.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - ) - -@pytest.mark.asyncio -async def test_list_glossaries_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_glossaries( - parent='parent_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 - -@pytest.mark.asyncio -async def test_list_glossaries_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - ) - - -def test_list_glossaries_pager(transport_name: str = "grpc"): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_glossaries(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in results) -def test_list_glossaries_pages(transport_name: str = "grpc"): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - pages = list(client.list_glossaries(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_glossaries_async_pager(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_glossaries(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_glossaries_async_pages(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_glossaries(request={}) - ).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - translation_service.GetGlossaryRequest, - dict, -]) -def test_get_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary( - name='name_value', - entry_count=1210, - display_name='display_name_value', - ) - response = client.get_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - assert response.display_name == 'display_name_value' - - -def test_get_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - client.get_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - -@pytest.mark.asyncio -async def test_get_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.GetGlossaryRequest): - client = TranslationServiceAsyncClient( - 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.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary( - name='name_value', - entry_count=1210, - display_name='display_name_value', - )) - response = await client.get_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - assert response.display_name == 'display_name_value' - - -@pytest.mark.asyncio -async def test_get_glossary_async_from_dict(): - await test_get_glossary_async(request_type=dict) - - -def test_get_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.GetGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - call.return_value = translation_service.Glossary() - client.get_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.GetGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary()) - await client.get_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_get_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_get_glossary_flattened_error(): - client = TranslationServiceClient( - 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.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DeleteGlossaryRequest, - dict, -]) -def test_delete_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - client.delete_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - -@pytest.mark.asyncio -async def test_delete_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.DeleteGlossaryRequest): - client = TranslationServiceAsyncClient( - 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.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_glossary_async_from_dict(): - await test_delete_glossary_async(request_type=dict) - - -def test_delete_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.DeleteGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.DeleteGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_delete_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_delete_glossary_flattened_error(): - client = TranslationServiceClient( - 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.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_delete_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateTextRequest, - dict, -]) -def test_translate_text_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.TranslateTextResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.TranslateTextResponse.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 - response = client.translate_text(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -def test_translate_text_rest_required_fields(request_type=translation_service.TranslateTextRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["contents"] = "" - request_init["target_language_code"] = "" - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_text._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["contents"] = 'contents_value' - jsonified_request["targetLanguageCode"] = 'target_language_code_value' - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_text._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "contents" in jsonified_request - assert jsonified_request["contents"] == 'contents_value' - assert "targetLanguageCode" in jsonified_request - assert jsonified_request["targetLanguageCode"] == 'target_language_code_value' - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.TranslateTextResponse() - # 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 = translation_service.TranslateTextResponse.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 - - response = client.translate_text(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_translate_text_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.translate_text._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("contents", "targetLanguageCode", "parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_translate_text_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_translate_text") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_translate_text") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.TranslateTextRequest.pb(translation_service.TranslateTextRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.TranslateTextResponse.to_json(translation_service.TranslateTextResponse()) - - request = translation_service.TranslateTextRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.TranslateTextResponse() - - client.translate_text(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_translate_text_rest_bad_request(transport: str = 'rest', request_type=translation_service.TranslateTextRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.translate_text(request) - - -def test_translate_text_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.TranslateTextResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_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 = translation_service.TranslateTextResponse.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 - - client.translate_text(**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/v3/{parent=projects/*/locations/*}:translateText" % client.transport._host, args[1]) - - -def test_translate_text_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.translate_text( - translation_service.TranslateTextRequest(), - parent='parent_value', - target_language_code='target_language_code_value', - contents=['contents_value'], - model='model_value', - mime_type='mime_type_value', - source_language_code='source_language_code_value', - ) - - -def test_translate_text_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DetectLanguageRequest, - dict, -]) -def test_detect_language_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.DetectLanguageResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.DetectLanguageResponse.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 - response = client.detect_language(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -def test_detect_language_rest_required_fields(request_type=translation_service.DetectLanguageRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).detect_language._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()).detect_language._get_unset_required_fields(jsonified_request) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.DetectLanguageResponse() - # 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 = translation_service.DetectLanguageResponse.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 - - response = client.detect_language(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_detect_language_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.detect_language._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_detect_language_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_detect_language") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_detect_language") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.DetectLanguageRequest.pb(translation_service.DetectLanguageRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.DetectLanguageResponse.to_json(translation_service.DetectLanguageResponse()) - - request = translation_service.DetectLanguageRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.DetectLanguageResponse() - - client.detect_language(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_detect_language_rest_bad_request(transport: str = 'rest', request_type=translation_service.DetectLanguageRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.detect_language(request) - - -def test_detect_language_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.DetectLanguageResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - model='model_value', - mime_type='mime_type_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 = translation_service.DetectLanguageResponse.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 - - client.detect_language(**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/v3/{parent=projects/*/locations/*}:detectLanguage" % client.transport._host, args[1]) - - -def test_detect_language_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - content='content_value', - ) - - -def test_detect_language_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetSupportedLanguagesRequest, - dict, -]) -def test_get_supported_languages_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.SupportedLanguages( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.SupportedLanguages.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 - response = client.get_supported_languages(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -def test_get_supported_languages_rest_required_fields(request_type=translation_service.GetSupportedLanguagesRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_supported_languages._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()).get_supported_languages._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("display_language_code", "model", )) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.SupportedLanguages() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.SupportedLanguages.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 - - response = client.get_supported_languages(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_supported_languages_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_supported_languages._get_unset_required_fields({}) - assert set(unset_fields) == (set(("displayLanguageCode", "model", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_supported_languages_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_get_supported_languages") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_get_supported_languages") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.GetSupportedLanguagesRequest.pb(translation_service.GetSupportedLanguagesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.SupportedLanguages.to_json(translation_service.SupportedLanguages()) - - request = translation_service.GetSupportedLanguagesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.SupportedLanguages() - - client.get_supported_languages(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_supported_languages_rest_bad_request(transport: str = 'rest', request_type=translation_service.GetSupportedLanguagesRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_supported_languages(request) - - -def test_get_supported_languages_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.SupportedLanguages() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - model='model_value', - display_language_code='display_language_code_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 = translation_service.SupportedLanguages.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 - - client.get_supported_languages(**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/v3/{parent=projects/*/locations/*}/supportedLanguages" % client.transport._host, args[1]) - - -def test_get_supported_languages_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - model='model_value', - display_language_code='display_language_code_value', - ) - - -def test_get_supported_languages_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateDocumentRequest, - dict, -]) -def test_translate_document_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.TranslateDocumentResponse( - model='model_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.TranslateDocumentResponse.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 - response = client.translate_document(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -def test_translate_document_rest_required_fields(request_type=translation_service.TranslateDocumentRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["target_language_code"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_document._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["targetLanguageCode"] = 'target_language_code_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_document._get_unset_required_fields(jsonified_request) - 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 "targetLanguageCode" in jsonified_request - assert jsonified_request["targetLanguageCode"] == 'target_language_code_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.TranslateDocumentResponse() - # 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 = translation_service.TranslateDocumentResponse.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 - - response = client.translate_document(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_translate_document_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.translate_document._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "targetLanguageCode", "documentInputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_translate_document_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_translate_document") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_translate_document") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.TranslateDocumentRequest.pb(translation_service.TranslateDocumentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.TranslateDocumentResponse.to_json(translation_service.TranslateDocumentResponse()) - - request = translation_service.TranslateDocumentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.TranslateDocumentResponse() - - client.translate_document(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_translate_document_rest_bad_request(transport: str = 'rest', request_type=translation_service.TranslateDocumentRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.translate_document(request) - - -def test_translate_document_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateTextRequest, - dict, -]) -def test_batch_translate_text_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.batch_translate_text(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_batch_translate_text_rest_required_fields(request_type=translation_service.BatchTranslateTextRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["source_language_code"] = "" - request_init["target_language_codes"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_text._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["sourceLanguageCode"] = 'source_language_code_value' - jsonified_request["targetLanguageCodes"] = 'target_language_codes_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_text._get_unset_required_fields(jsonified_request) - 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 "sourceLanguageCode" in jsonified_request - assert jsonified_request["sourceLanguageCode"] == 'source_language_code_value' - assert "targetLanguageCodes" in jsonified_request - assert jsonified_request["targetLanguageCodes"] == 'target_language_codes_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.batch_translate_text(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_batch_translate_text_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.batch_translate_text._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "sourceLanguageCode", "targetLanguageCodes", "inputConfigs", "outputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_batch_translate_text_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_batch_translate_text") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_batch_translate_text") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.BatchTranslateTextRequest.pb(translation_service.BatchTranslateTextRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.BatchTranslateTextRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.batch_translate_text(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_batch_translate_text_rest_bad_request(transport: str = 'rest', request_type=translation_service.BatchTranslateTextRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.batch_translate_text(request) - - -def test_batch_translate_text_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateDocumentRequest, - dict, -]) -def test_batch_translate_document_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.batch_translate_document(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_batch_translate_document_rest_required_fields(request_type=translation_service.BatchTranslateDocumentRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["source_language_code"] = "" - request_init["target_language_codes"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_document._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["sourceLanguageCode"] = 'source_language_code_value' - jsonified_request["targetLanguageCodes"] = 'target_language_codes_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_document._get_unset_required_fields(jsonified_request) - 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 "sourceLanguageCode" in jsonified_request - assert jsonified_request["sourceLanguageCode"] == 'source_language_code_value' - assert "targetLanguageCodes" in jsonified_request - assert jsonified_request["targetLanguageCodes"] == 'target_language_codes_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.batch_translate_document(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_batch_translate_document_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.batch_translate_document._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "sourceLanguageCode", "targetLanguageCodes", "inputConfigs", "outputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_batch_translate_document_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_batch_translate_document") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_batch_translate_document") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.BatchTranslateDocumentRequest.pb(translation_service.BatchTranslateDocumentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.BatchTranslateDocumentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.batch_translate_document(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_batch_translate_document_rest_bad_request(transport: str = 'rest', request_type=translation_service.BatchTranslateDocumentRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.batch_translate_document(request) - - -def test_batch_translate_document_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.batch_translate_document(**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/v3/{parent=projects/*/locations/*}:batchTranslateDocument" % client.transport._host, args[1]) - - -def test_batch_translate_document_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - - -def test_batch_translate_document_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.CreateGlossaryRequest, - dict, -]) -def test_create_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request_init["glossary"] = {'name': 'name_value', 'language_pair': {'source_language_code': 'source_language_code_value', 'target_language_code': 'target_language_code_value'}, 'language_codes_set': {'language_codes': ['language_codes_value1', 'language_codes_value2']}, 'input_config': {'gcs_source': {'input_uri': 'input_uri_value'}}, 'entry_count': 1210, 'submit_time': {'seconds': 751, 'nanos': 543}, 'end_time': {}, 'display_name': 'display_name_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 = translation_service.CreateGlossaryRequest.meta.fields["glossary"] - - 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["glossary"].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["glossary"][field])): - del request_init["glossary"][field][i][subfield] - else: - del request_init["glossary"][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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.create_glossary(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_create_glossary_rest_required_fields(request_type=translation_service.CreateGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_glossary._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_glossary._get_unset_required_fields(jsonified_request) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.create_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "glossary", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_create_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_create_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.CreateGlossaryRequest.pb(translation_service.CreateGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.CreateGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.create_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_create_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.CreateGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.create_glossary(request) - - -def test_create_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.create_glossary(**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/v3/{parent=projects/*/locations/*}/glossaries" % client.transport._host, args[1]) - - -def test_create_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - - -def test_create_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.ListGlossariesRequest, - dict, -]) -def test_list_glossaries_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.ListGlossariesResponse.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 - response = client.list_glossaries(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_glossaries_rest_required_fields(request_type=translation_service.ListGlossariesRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_glossaries._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()).list_glossaries._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("filter", "page_size", "page_token", )) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.ListGlossariesResponse() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.ListGlossariesResponse.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 - - response = client.list_glossaries(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_glossaries_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_glossaries._get_unset_required_fields({}) - assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_glossaries_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_list_glossaries") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_list_glossaries") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.ListGlossariesRequest.pb(translation_service.ListGlossariesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.ListGlossariesResponse.to_json(translation_service.ListGlossariesResponse()) - - request = translation_service.ListGlossariesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.ListGlossariesResponse() - - client.list_glossaries(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_glossaries_rest_bad_request(transport: str = 'rest', request_type=translation_service.ListGlossariesRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_glossaries(request) - - -def test_list_glossaries_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.ListGlossariesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_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 = translation_service.ListGlossariesResponse.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 - - client.list_glossaries(**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/v3/{parent=projects/*/locations/*}/glossaries" % client.transport._host, args[1]) - - -def test_list_glossaries_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - ) - - -def test_list_glossaries_rest_pager(transport: str = 'rest'): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(translation_service.ListGlossariesResponse.to_json(x) for x in response) - return_values = tuple(Response() for i in response) - for return_val, response_val in zip(return_values, response): - return_val._content = response_val.encode('UTF-8') - return_val.status_code = 200 - req.side_effect = return_values - - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - pager = client.list_glossaries(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in results) - - pages = list(client.list_glossaries(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetGlossaryRequest, - dict, -]) -def test_get_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = translation_service.Glossary( - name='name_value', - entry_count=1210, - display_name='display_name_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.Glossary.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 - response = client.get_glossary(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - assert response.display_name == 'display_name_value' - - -def test_get_glossary_rest_required_fields(request_type=translation_service.GetGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.Glossary() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.Glossary.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 - - response = client.get_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_get_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_get_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.GetGlossaryRequest.pb(translation_service.GetGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.Glossary.to_json(translation_service.Glossary()) - - request = translation_service.GetGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.Glossary() - - client.get_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.GetGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_glossary(request) - - -def test_get_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.Glossary() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_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 = translation_service.Glossary.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 - - client.get_glossary(**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/v3/{name=projects/*/locations/*/glossaries/*}" % client.transport._host, args[1]) - - -def test_get_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - - -def test_get_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DeleteGlossaryRequest, - dict, -]) -def test_delete_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_glossary(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_delete_glossary_rest_required_fields(request_type=translation_service.DeleteGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_delete_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_delete_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.DeleteGlossaryRequest.pb(translation_service.DeleteGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.DeleteGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.delete_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_delete_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.DeleteGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_glossary(request) - - -def test_delete_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_glossary(**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/v3/{name=projects/*/locations/*/glossaries/*}" % client.transport._host, args[1]) - - -def test_delete_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - - -def test_delete_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = TranslationServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.TranslationServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - transports.TranslationServiceRestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = TranslationServiceClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.TranslationServiceGrpcTransport, - ) - -def test_translation_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.TranslationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_translation_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.translate_v3.services.translation_service.transports.TranslationServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.TranslationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'translate_text', - 'detect_language', - 'get_supported_languages', - 'translate_document', - 'batch_translate_text', - 'batch_translate_document', - 'create_glossary', - 'list_glossaries', - 'get_glossary', - 'delete_glossary', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_translation_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.cloud.translate_v3.services.translation_service.transports.TranslationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.TranslationServiceTransport( - 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/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - quota_project_id="octopus", - ) - - -def test_translation_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.cloud.translate_v3.services.translation_service.transports.TranslationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.TranslationServiceTransport() - adc.assert_called_once() - - -def test_translation_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) - TranslationServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - ], -) -def test_translation_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/cloud-platform', 'https://www.googleapis.com/auth/cloud-translation',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - transports.TranslationServiceRestTransport, - ], -) -def test_translation_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.TranslationServiceGrpcTransport, grpc_helpers), - (transports.TranslationServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_translation_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( - "translate.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - scopes=["1", "2"], - default_host="translate.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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_translation_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.TranslationServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -def test_translation_service_rest_lro_client(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.AbstractOperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_translation_service_host_no_port(transport_name): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='translate.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://translate.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_translation_service_host_with_port(transport_name): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='translate.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'translate.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://translate.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_translation_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = TranslationServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = TranslationServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.translate_text._session - session2 = client2.transport.translate_text._session - assert session1 != session2 - session1 = client1.transport.detect_language._session - session2 = client2.transport.detect_language._session - assert session1 != session2 - session1 = client1.transport.get_supported_languages._session - session2 = client2.transport.get_supported_languages._session - assert session1 != session2 - session1 = client1.transport.translate_document._session - session2 = client2.transport.translate_document._session - assert session1 != session2 - session1 = client1.transport.batch_translate_text._session - session2 = client2.transport.batch_translate_text._session - assert session1 != session2 - session1 = client1.transport.batch_translate_document._session - session2 = client2.transport.batch_translate_document._session - assert session1 != session2 - session1 = client1.transport.create_glossary._session - session2 = client2.transport.create_glossary._session - assert session1 != session2 - session1 = client1.transport.list_glossaries._session - session2 = client2.transport.list_glossaries._session - assert session1 != session2 - session1 = client1.transport.get_glossary._session - session2 = client2.transport.get_glossary._session - assert session1 != session2 - session1 = client1.transport.delete_glossary._session - session2 = client2.transport.delete_glossary._session - assert session1 != session2 -def test_translation_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.TranslationServiceGrpcTransport( - 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_translation_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.TranslationServiceGrpcAsyncIOTransport( - 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.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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_translation_service_grpc_lro_client(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_translation_service_grpc_lro_async_client(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsAsyncClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_glossary_path(): - project = "squid" - location = "clam" - glossary = "whelk" - expected = "projects/{project}/locations/{location}/glossaries/{glossary}".format(project=project, location=location, glossary=glossary, ) - actual = TranslationServiceClient.glossary_path(project, location, glossary) - assert expected == actual - - -def test_parse_glossary_path(): - expected = { - "project": "octopus", - "location": "oyster", - "glossary": "nudibranch", - } - path = TranslationServiceClient.glossary_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_glossary_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = TranslationServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = TranslationServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = TranslationServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = TranslationServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = TranslationServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = TranslationServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = TranslationServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = TranslationServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "whelk" - location = "octopus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = TranslationServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = TranslationServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.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.TranslationServiceTransport, '_prep_wrapped_messages') as prep: - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.TranslationServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = TranslationServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - 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(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "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 = TranslationServiceClient( - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport), -]) -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, - 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/v3beta1/.coveragerc b/owl-bot-staging/v3beta1/.coveragerc deleted file mode 100644 index 2dc20114..00000000 --- a/owl-bot-staging/v3beta1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/translate/__init__.py - google/cloud/translate/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/v3beta1/.flake8 b/owl-bot-staging/v3beta1/.flake8 deleted file mode 100644 index 29227d4c..00000000 --- a/owl-bot-staging/v3beta1/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://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 by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/v3beta1/MANIFEST.in b/owl-bot-staging/v3beta1/MANIFEST.in deleted file mode 100644 index fd03605c..00000000 --- a/owl-bot-staging/v3beta1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/translate *.py -recursive-include google/cloud/translate_v3beta1 *.py diff --git a/owl-bot-staging/v3beta1/README.rst b/owl-bot-staging/v3beta1/README.rst deleted file mode 100644 index d16a64f0..00000000 --- a/owl-bot-staging/v3beta1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Translate 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 Cloud Translate 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 diff --git a/owl-bot-staging/v3beta1/docs/_static/custom.css b/owl-bot-staging/v3beta1/docs/_static/custom.css deleted file mode 100644 index 06423be0..00000000 --- a/owl-bot-staging/v3beta1/docs/_static/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -dl.field-list > dt { - min-width: 100px -} diff --git a/owl-bot-staging/v3beta1/docs/conf.py b/owl-bot-staging/v3beta1/docs/conf.py deleted file mode 100644 index ed053307..00000000 --- a/owl-bot-staging/v3beta1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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-cloud-translate 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("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# 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.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -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-cloud-translate" -copyright = u"2023, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# 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 = 'en' - -# 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"] - -# 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 Cloud Client Libraries for Python", - "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-cloud-translate-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-cloud-translate.tex", - u"google-cloud-translate 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-cloud-translate", - u"Google Cloud Translate 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-cloud-translate", - u"google-cloud-translate Documentation", - author, - "google-cloud-translate", - "GAPIC library for Google Cloud Translate API", - "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": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", 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/v3beta1/docs/index.rst b/owl-bot-staging/v3beta1/docs/index.rst deleted file mode 100644 index 0c7f08e2..00000000 --- a/owl-bot-staging/v3beta1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - translate_v3beta1/services - translate_v3beta1/types diff --git a/owl-bot-staging/v3beta1/docs/translate_v3beta1/services.rst b/owl-bot-staging/v3beta1/docs/translate_v3beta1/services.rst deleted file mode 100644 index 2e364924..00000000 --- a/owl-bot-staging/v3beta1/docs/translate_v3beta1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Translate v3beta1 API -=============================================== -.. toctree:: - :maxdepth: 2 - - translation_service diff --git a/owl-bot-staging/v3beta1/docs/translate_v3beta1/translation_service.rst b/owl-bot-staging/v3beta1/docs/translate_v3beta1/translation_service.rst deleted file mode 100644 index 743d0126..00000000 --- a/owl-bot-staging/v3beta1/docs/translate_v3beta1/translation_service.rst +++ /dev/null @@ -1,10 +0,0 @@ -TranslationService ------------------------------------- - -.. automodule:: google.cloud.translate_v3beta1.services.translation_service - :members: - :inherited-members: - -.. automodule:: google.cloud.translate_v3beta1.services.translation_service.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v3beta1/docs/translate_v3beta1/types.rst b/owl-bot-staging/v3beta1/docs/translate_v3beta1/types.rst deleted file mode 100644 index b5640f8f..00000000 --- a/owl-bot-staging/v3beta1/docs/translate_v3beta1/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Translate v3beta1 API -============================================ - -.. automodule:: google.cloud.translate_v3beta1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/v3beta1/google/cloud/translate/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate/__init__.py deleted file mode 100644 index e337c6d3..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate/__init__.py +++ /dev/null @@ -1,101 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.translate import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.translate_v3beta1.services.translation_service.client import TranslationServiceClient -from google.cloud.translate_v3beta1.services.translation_service.async_client import TranslationServiceAsyncClient - -from google.cloud.translate_v3beta1.types.translation_service import BatchDocumentInputConfig -from google.cloud.translate_v3beta1.types.translation_service import BatchDocumentOutputConfig -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateDocumentMetadata -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateDocumentRequest -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateDocumentResponse -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateMetadata -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateResponse -from google.cloud.translate_v3beta1.types.translation_service import BatchTranslateTextRequest -from google.cloud.translate_v3beta1.types.translation_service import CreateGlossaryMetadata -from google.cloud.translate_v3beta1.types.translation_service import CreateGlossaryRequest -from google.cloud.translate_v3beta1.types.translation_service import DeleteGlossaryMetadata -from google.cloud.translate_v3beta1.types.translation_service import DeleteGlossaryRequest -from google.cloud.translate_v3beta1.types.translation_service import DeleteGlossaryResponse -from google.cloud.translate_v3beta1.types.translation_service import DetectedLanguage -from google.cloud.translate_v3beta1.types.translation_service import DetectLanguageRequest -from google.cloud.translate_v3beta1.types.translation_service import DetectLanguageResponse -from google.cloud.translate_v3beta1.types.translation_service import DocumentInputConfig -from google.cloud.translate_v3beta1.types.translation_service import DocumentOutputConfig -from google.cloud.translate_v3beta1.types.translation_service import DocumentTranslation -from google.cloud.translate_v3beta1.types.translation_service import GcsDestination -from google.cloud.translate_v3beta1.types.translation_service import GcsSource -from google.cloud.translate_v3beta1.types.translation_service import GetGlossaryRequest -from google.cloud.translate_v3beta1.types.translation_service import GetSupportedLanguagesRequest -from google.cloud.translate_v3beta1.types.translation_service import Glossary -from google.cloud.translate_v3beta1.types.translation_service import GlossaryInputConfig -from google.cloud.translate_v3beta1.types.translation_service import InputConfig -from google.cloud.translate_v3beta1.types.translation_service import ListGlossariesRequest -from google.cloud.translate_v3beta1.types.translation_service import ListGlossariesResponse -from google.cloud.translate_v3beta1.types.translation_service import OutputConfig -from google.cloud.translate_v3beta1.types.translation_service import SupportedLanguage -from google.cloud.translate_v3beta1.types.translation_service import SupportedLanguages -from google.cloud.translate_v3beta1.types.translation_service import TranslateDocumentRequest -from google.cloud.translate_v3beta1.types.translation_service import TranslateDocumentResponse -from google.cloud.translate_v3beta1.types.translation_service import TranslateTextGlossaryConfig -from google.cloud.translate_v3beta1.types.translation_service import TranslateTextRequest -from google.cloud.translate_v3beta1.types.translation_service import TranslateTextResponse -from google.cloud.translate_v3beta1.types.translation_service import Translation - -__all__ = ('TranslationServiceClient', - 'TranslationServiceAsyncClient', - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentMetadata', - 'BatchTranslateDocumentRequest', - 'BatchTranslateDocumentResponse', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'BatchTranslateTextRequest', - 'CreateGlossaryMetadata', - 'CreateGlossaryRequest', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryRequest', - 'DeleteGlossaryResponse', - 'DetectedLanguage', - 'DetectLanguageRequest', - 'DetectLanguageResponse', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'DocumentTranslation', - 'GcsDestination', - 'GcsSource', - 'GetGlossaryRequest', - 'GetSupportedLanguagesRequest', - 'Glossary', - 'GlossaryInputConfig', - 'InputConfig', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'OutputConfig', - 'SupportedLanguage', - 'SupportedLanguages', - 'TranslateDocumentRequest', - 'TranslateDocumentResponse', - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate/gapic_version.py b/owl-bot-staging/v3beta1/google/cloud/translate/gapic_version.py deleted file mode 100644 index 360a0d13..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/google/cloud/translate/py.typed b/owl-bot-staging/v3beta1/google/cloud/translate/py.typed deleted file mode 100644 index 39eb1d6c..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-translate package uses inline types. diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/__init__.py deleted file mode 100644 index 740d6171..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/__init__.py +++ /dev/null @@ -1,102 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.cloud.translate_v3beta1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.translation_service import TranslationServiceClient -from .services.translation_service import TranslationServiceAsyncClient - -from .types.translation_service import BatchDocumentInputConfig -from .types.translation_service import BatchDocumentOutputConfig -from .types.translation_service import BatchTranslateDocumentMetadata -from .types.translation_service import BatchTranslateDocumentRequest -from .types.translation_service import BatchTranslateDocumentResponse -from .types.translation_service import BatchTranslateMetadata -from .types.translation_service import BatchTranslateResponse -from .types.translation_service import BatchTranslateTextRequest -from .types.translation_service import CreateGlossaryMetadata -from .types.translation_service import CreateGlossaryRequest -from .types.translation_service import DeleteGlossaryMetadata -from .types.translation_service import DeleteGlossaryRequest -from .types.translation_service import DeleteGlossaryResponse -from .types.translation_service import DetectedLanguage -from .types.translation_service import DetectLanguageRequest -from .types.translation_service import DetectLanguageResponse -from .types.translation_service import DocumentInputConfig -from .types.translation_service import DocumentOutputConfig -from .types.translation_service import DocumentTranslation -from .types.translation_service import GcsDestination -from .types.translation_service import GcsSource -from .types.translation_service import GetGlossaryRequest -from .types.translation_service import GetSupportedLanguagesRequest -from .types.translation_service import Glossary -from .types.translation_service import GlossaryInputConfig -from .types.translation_service import InputConfig -from .types.translation_service import ListGlossariesRequest -from .types.translation_service import ListGlossariesResponse -from .types.translation_service import OutputConfig -from .types.translation_service import SupportedLanguage -from .types.translation_service import SupportedLanguages -from .types.translation_service import TranslateDocumentRequest -from .types.translation_service import TranslateDocumentResponse -from .types.translation_service import TranslateTextGlossaryConfig -from .types.translation_service import TranslateTextRequest -from .types.translation_service import TranslateTextResponse -from .types.translation_service import Translation - -__all__ = ( - 'TranslationServiceAsyncClient', -'BatchDocumentInputConfig', -'BatchDocumentOutputConfig', -'BatchTranslateDocumentMetadata', -'BatchTranslateDocumentRequest', -'BatchTranslateDocumentResponse', -'BatchTranslateMetadata', -'BatchTranslateResponse', -'BatchTranslateTextRequest', -'CreateGlossaryMetadata', -'CreateGlossaryRequest', -'DeleteGlossaryMetadata', -'DeleteGlossaryRequest', -'DeleteGlossaryResponse', -'DetectLanguageRequest', -'DetectLanguageResponse', -'DetectedLanguage', -'DocumentInputConfig', -'DocumentOutputConfig', -'DocumentTranslation', -'GcsDestination', -'GcsSource', -'GetGlossaryRequest', -'GetSupportedLanguagesRequest', -'Glossary', -'GlossaryInputConfig', -'InputConfig', -'ListGlossariesRequest', -'ListGlossariesResponse', -'OutputConfig', -'SupportedLanguage', -'SupportedLanguages', -'TranslateDocumentRequest', -'TranslateDocumentResponse', -'TranslateTextGlossaryConfig', -'TranslateTextRequest', -'TranslateTextResponse', -'Translation', -'TranslationServiceClient', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_metadata.json b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_metadata.json deleted file mode 100644 index 8ad815f3..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_metadata.json +++ /dev/null @@ -1,178 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.translate_v3beta1", - "protoPackage": "google.cloud.translation.v3beta1", - "schema": "1.0", - "services": { - "TranslationService": { - "clients": { - "grpc": { - "libraryClient": "TranslationServiceClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - }, - "grpc-async": { - "libraryClient": "TranslationServiceAsyncClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - }, - "rest": { - "libraryClient": "TranslationServiceClient", - "rpcs": { - "BatchTranslateDocument": { - "methods": [ - "batch_translate_document" - ] - }, - "BatchTranslateText": { - "methods": [ - "batch_translate_text" - ] - }, - "CreateGlossary": { - "methods": [ - "create_glossary" - ] - }, - "DeleteGlossary": { - "methods": [ - "delete_glossary" - ] - }, - "DetectLanguage": { - "methods": [ - "detect_language" - ] - }, - "GetGlossary": { - "methods": [ - "get_glossary" - ] - }, - "GetSupportedLanguages": { - "methods": [ - "get_supported_languages" - ] - }, - "ListGlossaries": { - "methods": [ - "list_glossaries" - ] - }, - "TranslateDocument": { - "methods": [ - "translate_document" - ] - }, - "TranslateText": { - "methods": [ - "translate_text" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_version.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_version.py deleted file mode 100644 index 360a0d13..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/google/cloud/translate_v3beta1/py.typed b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/py.typed deleted file mode 100644 index 39eb1d6c..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-translate package uses inline types. diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/__init__.py deleted file mode 100644 index 89a37dc9..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/google/cloud/translate_v3beta1/services/translation_service/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/__init__.py deleted file mode 100644 index 8717f41e..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslationServiceClient -from .async_client import TranslationServiceAsyncClient - -__all__ = ( - 'TranslationServiceClient', - 'TranslationServiceAsyncClient', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/async_client.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/async_client.py deleted file mode 100644 index a3592333..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/async_client.py +++ /dev/null @@ -1,1494 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.translate_v3beta1 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 as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.translate_v3beta1.services.translation_service import pagers -from google.cloud.translate_v3beta1.types import translation_service -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .client import TranslationServiceClient - - -class TranslationServiceAsyncClient: - """Provides natural language translation operations.""" - - _client: TranslationServiceClient - - DEFAULT_ENDPOINT = TranslationServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = TranslationServiceClient.DEFAULT_MTLS_ENDPOINT - - glossary_path = staticmethod(TranslationServiceClient.glossary_path) - parse_glossary_path = staticmethod(TranslationServiceClient.parse_glossary_path) - common_billing_account_path = staticmethod(TranslationServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(TranslationServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(TranslationServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(TranslationServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(TranslationServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(TranslationServiceClient.parse_common_organization_path) - common_project_path = staticmethod(TranslationServiceClient.common_project_path) - parse_common_project_path = staticmethod(TranslationServiceClient.parse_common_project_path) - common_location_path = staticmethod(TranslationServiceClient.common_location_path) - parse_common_location_path = staticmethod(TranslationServiceClient.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: - TranslationServiceAsyncClient: The constructed client. - """ - return TranslationServiceClient.from_service_account_info.__func__(TranslationServiceAsyncClient, 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: - TranslationServiceAsyncClient: The constructed client. - """ - return TranslationServiceClient.from_service_account_file.__func__(TranslationServiceAsyncClient, 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 TranslationServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> TranslationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - TranslationServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(TranslationServiceClient).get_transport_class, type(TranslationServiceClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, TranslationServiceTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the translation 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 (Union[str, ~.TranslationServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "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). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS 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. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = TranslationServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def translate_text(self, - request: Optional[Union[translation_service.TranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateTextResponse: - r"""Translates input text and returns translated text. - - .. 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.cloud import translate_v3beta1 - - async def sample_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = await client.translate_text(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.TranslateTextRequest, dict]]): - The request object. The request message for synchronous - translation. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.TranslateTextResponse: - - """ - # Create or coerce a protobuf request object. - request = translation_service.TranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.translate_text, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def detect_language(self, - request: Optional[Union[translation_service.DetectLanguageRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.DetectLanguageResponse: - r"""Detects the language of text within a request. - - .. 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.cloud import translate_v3beta1 - - async def sample_detect_language(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = await client.detect_language(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.DetectLanguageRequest, dict]]): - The request object. The request message for language - detection. - parent (:class:`str`): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same - location-id) can be used. Otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (:class:`str`): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently - supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (:class:`str`): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.DetectLanguageResponse: - The response message for language - detection. - - """ - # 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. - has_flattened_params = any([parent, model, mime_type]) - 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.") - - request = translation_service.DetectLanguageRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.detect_language, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_supported_languages(self, - request: Optional[Union[translation_service.GetSupportedLanguagesRequest, dict]] = None, - *, - parent: Optional[str] = None, - display_language_code: Optional[str] = None, - model: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.SupportedLanguages: - r"""Returns a list of supported languages for - translation. - - .. 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.cloud import translate_v3beta1 - - async def sample_get_supported_languages(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = await client.get_supported_languages(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest, dict]]): - The request object. The request message for discovering - supported languages. - parent (:class:`str`): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same - location-id) can be used, otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - display_language_code (:class:`str`): - Optional. The language to use to - return localized, human readable names - of supported languages. If missing, then - display names are not returned in a - response. - - This corresponds to the ``display_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (:class:`str`): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general - NMT model. - - This corresponds to the ``model`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.SupportedLanguages: - The response message for discovering - supported languages. - - """ - # 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. - has_flattened_params = any([parent, display_language_code, model]) - 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.") - - request = translation_service.GetSupportedLanguagesRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if display_language_code is not None: - request.display_language_code = display_language_code - if model is not None: - request.model = model - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_supported_languages, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def translate_document(self, - request: Optional[Union[translation_service.TranslateDocumentRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateDocumentResponse: - r"""Translates documents in synchronous mode. - - .. 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.cloud import translate_v3beta1 - - async def sample_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - document_input_config = translate_v3beta1.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3beta1.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = await client.translate_document(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.TranslateDocumentRequest, dict]]): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.TranslateDocumentResponse: - A translated document response - message. - - """ - # Create or coerce a protobuf request object. - request = translation_service.TranslateDocumentRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.translate_document, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def batch_translate_text(self, - request: Optional[Union[translation_service.BatchTranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - .. 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.cloud import translate_v3beta1 - - async def sample_batch_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest, dict]]): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.BatchTranslateResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one - sentence is translated successfully. - - """ - # Create or coerce a protobuf request object. - request = translation_service.BatchTranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.batch_translate_text, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.BatchTranslateResponse, - metadata_type=translation_service.BatchTranslateMetadata, - ) - - # Done; return the response. - return response - - async def batch_translate_document(self, - request: Optional[Union[translation_service.BatchTranslateDocumentRequest, dict]] = None, - *, - parent: Optional[str] = None, - source_language_code: Optional[str] = None, - target_language_codes: Optional[MutableSequence[str]] = None, - input_configs: Optional[MutableSequence[translation_service.BatchDocumentInputConfig]] = None, - output_config: Optional[translation_service.BatchDocumentOutputConfig] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - .. 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.cloud import translate_v3beta1 - - async def sample_batch_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest, dict]]): - The request object. The BatchTranslateDocument request. - parent (:class:`str`): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the - same region (have the same location-id) can be used, - otherwise an INVALID_ARGUMENT (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (:class:`str`): - Required. The BCP-47 language code of the input document - if known, for example, "en-US" or "sr-Latn". Supported - language codes are listed in `Language - Support `__. - - This corresponds to the ``source_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_codes (:class:`MutableSequence[str]`): - Required. The BCP-47 language code to - use for translation of the input - document. Specify up to 10 language - codes here. - - This corresponds to the ``target_language_codes`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - input_configs (:class:`MutableSequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]`): - Required. Input configurations. - The total number of files matched should - be <= 100. The total content size to - translate should be <= 100M Unicode - codepoints. The files must use UTF-8 - encoding. - - This corresponds to the ``input_configs`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - output_config (:class:`google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig`): - Required. Output configuration. - If 2 input configs match to the same - file (that is, same input path), we - don't generate output for duplicate - inputs. - - This corresponds to the ``output_config`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.BatchTranslateDocumentResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least - one document is translated successfully. - - """ - # 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. - has_flattened_params = any([parent, source_language_code, target_language_codes, input_configs, output_config]) - 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.") - - request = translation_service.BatchTranslateDocumentRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if source_language_code is not None: - request.source_language_code = source_language_code - if output_config is not None: - request.output_config = output_config - if target_language_codes: - request.target_language_codes.extend(target_language_codes) - if input_configs: - request.input_configs.extend(input_configs) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.batch_translate_document, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.BatchTranslateDocumentResponse, - metadata_type=translation_service.BatchTranslateDocumentMetadata, - ) - - # Done; return the response. - return response - - async def create_glossary(self, - request: Optional[Union[translation_service.CreateGlossaryRequest, dict]] = None, - *, - parent: Optional[str] = None, - glossary: Optional[translation_service.Glossary] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - .. 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.cloud import translate_v3beta1 - - async def sample_create_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - glossary = translate_v3beta1.Glossary() - glossary.name = "name_value" - - request = translate_v3beta1.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.CreateGlossaryRequest, dict]]): - The request object. Request message for CreateGlossary. - parent (:class:`str`): - Required. The project name. - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - glossary (:class:`google.cloud.translate_v3beta1.types.Glossary`): - Required. The glossary to create. - This corresponds to the ``glossary`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.translate_v3beta1.types.Glossary` - Represents a glossary built from user provided data. - - """ - # 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. - has_flattened_params = any([parent, glossary]) - 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.") - - request = translation_service.CreateGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if glossary is not None: - request.glossary = glossary - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.create_glossary, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.Glossary, - metadata_type=translation_service.CreateGlossaryMetadata, - ) - - # Done; return the response. - return response - - async def list_glossaries(self, - request: Optional[Union[translation_service.ListGlossariesRequest, dict]] = None, - *, - parent: Optional[str] = None, - filter: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGlossariesAsyncPager: - r"""Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - .. 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.cloud import translate_v3beta1 - - async def sample_list_glossaries(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - async for response in page_result: - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.ListGlossariesRequest, dict]]): - The request object. Request message for ListGlossaries. - parent (:class:`str`): - Required. The name of the project - from which to list all of the - glossaries. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (:class:`str`): - Optional. Filter specifying - constraints of a list operation. Specify - the constraint by the format of - "key=value", where key must be "src" or - "tgt", and the value must be a valid - language code. For multiple - restrictions, concatenate them by "AND" - (uppercase only), such as: "src=en-US - AND tgt=zh-CN". Notice that the exact - match is used here, which means using - 'en-US' and 'en' can lead to different - results, which depends on the language - code you used when you create the - glossary. For the unidirectional - glossaries, the "src" and "tgt" add - restrictions on the source and target - language code separately. For the - equivalent term set glossaries, the - "src" and/or "tgt" add restrictions on - the term set. - For example: "src=en-US AND tgt=zh-CN" - will only pick the unidirectional - glossaries which exactly match the - source language code as "en-US" and the - target language code "zh-CN", but all - equivalent term set glossaries which - contain "en-US" and "zh-CN" in their - language set will be picked. If missing, - no filtering is performed. - - This corresponds to the ``filter`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.services.translation_service.pagers.ListGlossariesAsyncPager: - Response message for ListGlossaries. - - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # 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. - has_flattened_params = any([parent, filter]) - 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.") - - request = translation_service.ListGlossariesRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_glossaries, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__aiter__` convenience method. - response = pagers.ListGlossariesAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_glossary(self, - request: Optional[Union[translation_service.GetGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.Glossary: - r"""Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - .. 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.cloud import translate_v3beta1 - - async def sample_get_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = await client.get_glossary(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.GetGlossaryRequest, dict]]): - The request object. Request message for GetGlossary. - name (:class:`str`): - Required. The name of the glossary to - retrieve. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.Glossary: - Represents a glossary built from user - provided data. - - """ - # 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. - has_flattened_params = any([name]) - 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.") - - request = translation_service.GetGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_glossary(self, - request: Optional[Union[translation_service.DeleteGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - .. 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.cloud import translate_v3beta1 - - async def sample_delete_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.translate_v3beta1.types.DeleteGlossaryRequest, dict]]): - The request object. Request message for DeleteGlossary. - name (:class:`str`): - Required. The name of the glossary to - delete. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation_async.AsyncOperation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.DeleteGlossaryResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - """ - # 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. - has_flattened_params = any([name]) - 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.") - - request = translation_service.DeleteGlossaryRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation_async.from_gapic( - response, - self._client._transport.operations_client, - translation_service.DeleteGlossaryResponse, - metadata_type=translation_service.DeleteGlossaryMetadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "TranslationServiceAsyncClient": - 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__) - - -__all__ = ( - "TranslationServiceAsyncClient", -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/client.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/client.py deleted file mode 100644 index b66607c1..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/client.py +++ /dev/null @@ -1,1673 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.translate_v3beta1 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 - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.translate_v3beta1.services.translation_service import pagers -from google.cloud.translate_v3beta1.types import translation_service -from google.protobuf import timestamp_pb2 # type: ignore -from .transports.base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import TranslationServiceGrpcTransport -from .transports.grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .transports.rest import TranslationServiceRestTransport - - -class TranslationServiceClientMeta(type): - """Metaclass for the TranslationService 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[TranslationServiceTransport]] - _transport_registry["grpc"] = TranslationServiceGrpcTransport - _transport_registry["grpc_asyncio"] = TranslationServiceGrpcAsyncIOTransport - _transport_registry["rest"] = TranslationServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[TranslationServiceTransport]: - """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 TranslationServiceClient(metaclass=TranslationServiceClientMeta): - """Provides natural language translation operations.""" - - @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") - - DEFAULT_ENDPOINT = "translate.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @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: - TranslationServiceClient: 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: - TranslationServiceClient: 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) -> TranslationServiceTransport: - """Returns the transport used by the client instance. - - Returns: - TranslationServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def glossary_path(project: str,location: str,glossary: str,) -> str: - """Returns a fully-qualified glossary string.""" - return "projects/{project}/locations/{location}/glossaries/{glossary}".format(project=project, location=location, glossary=glossary, ) - - @staticmethod - def parse_glossary_path(path: str) -> Dict[str,str]: - """Parses a glossary path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/glossaries/(?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): - """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. - """ - 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 - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, TranslationServiceTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the translation 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 (Union[str, TranslationServiceTransport]): The - transport to use. 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. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "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). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS 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. - 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. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - client_options = cast(client_options_lib.ClientOptions, client_options) - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(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. - if isinstance(transport, TranslationServiceTransport): - # transport is a TranslationServiceTransport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - 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 = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=client_options.api_audience, - ) - - def translate_text(self, - request: Optional[Union[translation_service.TranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateTextResponse: - r"""Translates input text and returns translated text. - - .. 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.cloud import translate_v3beta1 - - def sample_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = client.translate_text(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.TranslateTextRequest, dict]): - The request object. The request message for synchronous - translation. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.TranslateTextResponse: - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.TranslateTextRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.TranslateTextRequest): - request = translation_service.TranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.translate_text] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def detect_language(self, - request: Optional[Union[translation_service.DetectLanguageRequest, dict]] = None, - *, - parent: Optional[str] = None, - model: Optional[str] = None, - mime_type: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.DetectLanguageResponse: - r"""Detects the language of text within a request. - - .. 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.cloud import translate_v3beta1 - - def sample_detect_language(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = client.detect_language(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.DetectLanguageRequest, dict]): - The request object. The request message for language - detection. - parent (str): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same - location-id) can be used. Otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (str): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently - supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - - This corresponds to the ``model`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - mime_type (str): - Optional. The format of the source - text, for example, "text/html", - "text/plain". If left blank, the MIME - type defaults to "text/html". - - This corresponds to the ``mime_type`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.DetectLanguageResponse: - The response message for language - detection. - - """ - # 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. - has_flattened_params = any([parent, model, mime_type]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.DetectLanguageRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.DetectLanguageRequest): - request = translation_service.DetectLanguageRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if model is not None: - request.model = model - if mime_type is not None: - request.mime_type = mime_type - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.detect_language] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_supported_languages(self, - request: Optional[Union[translation_service.GetSupportedLanguagesRequest, dict]] = None, - *, - parent: Optional[str] = None, - display_language_code: Optional[str] = None, - model: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.SupportedLanguages: - r"""Returns a list of supported languages for - translation. - - .. 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.cloud import translate_v3beta1 - - def sample_get_supported_languages(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = client.get_supported_languages(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest, dict]): - The request object. The request message for discovering - supported languages. - parent (str): - Required. Project or location to make a call. Must refer - to a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same - location-id) can be used, otherwise an INVALID_ARGUMENT - (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - display_language_code (str): - Optional. The language to use to - return localized, human readable names - of supported languages. If missing, then - display names are not returned in a - response. - - This corresponds to the ``display_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - model (str): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general - NMT model. - - This corresponds to the ``model`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.SupportedLanguages: - The response message for discovering - supported languages. - - """ - # 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. - has_flattened_params = any([parent, display_language_code, model]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.GetSupportedLanguagesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.GetSupportedLanguagesRequest): - request = translation_service.GetSupportedLanguagesRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if display_language_code is not None: - request.display_language_code = display_language_code - if model is not None: - request.model = model - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_supported_languages] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def translate_document(self, - request: Optional[Union[translation_service.TranslateDocumentRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.TranslateDocumentResponse: - r"""Translates documents in synchronous mode. - - .. 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.cloud import translate_v3beta1 - - def sample_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - document_input_config = translate_v3beta1.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3beta1.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = client.translate_document(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.TranslateDocumentRequest, dict]): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.TranslateDocumentResponse: - A translated document response - message. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.TranslateDocumentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.TranslateDocumentRequest): - request = translation_service.TranslateDocumentRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.translate_document] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def batch_translate_text(self, - request: Optional[Union[translation_service.BatchTranslateTextRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - .. 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.cloud import translate_v3beta1 - - def sample_batch_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest, dict]): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.BatchTranslateResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one - sentence is translated successfully. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.BatchTranslateTextRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.BatchTranslateTextRequest): - request = translation_service.BatchTranslateTextRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.batch_translate_text] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.BatchTranslateResponse, - metadata_type=translation_service.BatchTranslateMetadata, - ) - - # Done; return the response. - return response - - def batch_translate_document(self, - request: Optional[Union[translation_service.BatchTranslateDocumentRequest, dict]] = None, - *, - parent: Optional[str] = None, - source_language_code: Optional[str] = None, - target_language_codes: Optional[MutableSequence[str]] = None, - input_configs: Optional[MutableSequence[translation_service.BatchDocumentInputConfig]] = None, - output_config: Optional[translation_service.BatchDocumentOutputConfig] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - .. 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.cloud import translate_v3beta1 - - def sample_batch_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest, dict]): - The request object. The BatchTranslateDocument request. - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the - same region (have the same location-id) can be used, - otherwise an INVALID_ARGUMENT (400) error is returned. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - source_language_code (str): - Required. The BCP-47 language code of the input document - if known, for example, "en-US" or "sr-Latn". Supported - language codes are listed in `Language - Support `__. - - This corresponds to the ``source_language_code`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - target_language_codes (MutableSequence[str]): - Required. The BCP-47 language code to - use for translation of the input - document. Specify up to 10 language - codes here. - - This corresponds to the ``target_language_codes`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - input_configs (MutableSequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]): - Required. Input configurations. - The total number of files matched should - be <= 100. The total content size to - translate should be <= 100M Unicode - codepoints. The files must use UTF-8 - encoding. - - This corresponds to the ``input_configs`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - output_config (google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig): - Required. Output configuration. - If 2 input configs match to the same - file (that is, same input path), we - don't generate output for duplicate - inputs. - - This corresponds to the ``output_config`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.BatchTranslateDocumentResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least - one document is translated successfully. - - """ - # 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. - has_flattened_params = any([parent, source_language_code, target_language_codes, input_configs, output_config]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.BatchTranslateDocumentRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.BatchTranslateDocumentRequest): - request = translation_service.BatchTranslateDocumentRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if source_language_code is not None: - request.source_language_code = source_language_code - if target_language_codes is not None: - request.target_language_codes = target_language_codes - if input_configs is not None: - request.input_configs = input_configs - if output_config is not None: - request.output_config = output_config - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.batch_translate_document] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.BatchTranslateDocumentResponse, - metadata_type=translation_service.BatchTranslateDocumentMetadata, - ) - - # Done; return the response. - return response - - def create_glossary(self, - request: Optional[Union[translation_service.CreateGlossaryRequest, dict]] = None, - *, - parent: Optional[str] = None, - glossary: Optional[translation_service.Glossary] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - .. 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.cloud import translate_v3beta1 - - def sample_create_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - glossary = translate_v3beta1.Glossary() - glossary.name = "name_value" - - request = translate_v3beta1.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.CreateGlossaryRequest, dict]): - The request object. Request message for CreateGlossary. - parent (str): - Required. The project name. - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - glossary (google.cloud.translate_v3beta1.types.Glossary): - Required. The glossary to create. - This corresponds to the ``glossary`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be - :class:`google.cloud.translate_v3beta1.types.Glossary` - Represents a glossary built from user provided data. - - """ - # 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. - has_flattened_params = any([parent, glossary]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.CreateGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.CreateGlossaryRequest): - request = translation_service.CreateGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if glossary is not None: - request.glossary = glossary - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_glossary] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.Glossary, - metadata_type=translation_service.CreateGlossaryMetadata, - ) - - # Done; return the response. - return response - - def list_glossaries(self, - request: Optional[Union[translation_service.ListGlossariesRequest, dict]] = None, - *, - parent: Optional[str] = None, - filter: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListGlossariesPager: - r"""Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - .. 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.cloud import translate_v3beta1 - - def sample_list_glossaries(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - for response in page_result: - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.ListGlossariesRequest, dict]): - The request object. Request message for ListGlossaries. - parent (str): - Required. The name of the project - from which to list all of the - glossaries. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - filter (str): - Optional. Filter specifying - constraints of a list operation. Specify - the constraint by the format of - "key=value", where key must be "src" or - "tgt", and the value must be a valid - language code. For multiple - restrictions, concatenate them by "AND" - (uppercase only), such as: "src=en-US - AND tgt=zh-CN". Notice that the exact - match is used here, which means using - 'en-US' and 'en' can lead to different - results, which depends on the language - code you used when you create the - glossary. For the unidirectional - glossaries, the "src" and "tgt" add - restrictions on the source and target - language code separately. For the - equivalent term set glossaries, the - "src" and/or "tgt" add restrictions on - the term set. - For example: "src=en-US AND tgt=zh-CN" - will only pick the unidirectional - glossaries which exactly match the - source language code as "en-US" and the - target language code "zh-CN", but all - equivalent term set glossaries which - contain "en-US" and "zh-CN" in their - language set will be picked. If missing, - no filtering is performed. - - This corresponds to the ``filter`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.services.translation_service.pagers.ListGlossariesPager: - Response message for ListGlossaries. - - Iterating over this object will yield - results and resolve additional pages - automatically. - - """ - # 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. - has_flattened_params = any([parent, filter]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.ListGlossariesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.ListGlossariesRequest): - request = translation_service.ListGlossariesRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if filter is not None: - request.filter = filter - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_glossaries] - - # 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # This method is paged; wrap the response in a pager, which provides - # an `__iter__` convenience method. - response = pagers.ListGlossariesPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_glossary(self, - request: Optional[Union[translation_service.GetGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> translation_service.Glossary: - r"""Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - .. 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.cloud import translate_v3beta1 - - def sample_get_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = client.get_glossary(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.GetGlossaryRequest, dict]): - The request object. Request message for GetGlossary. - name (str): - Required. The name of the glossary to - retrieve. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.translate_v3beta1.types.Glossary: - Represents a glossary built from user - provided data. - - """ - # 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. - has_flattened_params = any([name]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.GetGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.GetGlossaryRequest): - request = translation_service.GetGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_glossary] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_glossary(self, - request: Optional[Union[translation_service.DeleteGlossaryRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - .. 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.cloud import translate_v3beta1 - - def sample_delete_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.translate_v3beta1.types.DeleteGlossaryRequest, dict]): - The request object. Request message for DeleteGlossary. - name (str): - Required. The name of the glossary to - delete. - - This corresponds to the ``name`` 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.api_core.operation.Operation: - An object representing a long-running operation. - - The result type for the operation will be :class:`google.cloud.translate_v3beta1.types.DeleteGlossaryResponse` Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - """ - # 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. - has_flattened_params = any([name]) - 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a translation_service.DeleteGlossaryRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, translation_service.DeleteGlossaryRequest): - request = translation_service.DeleteGlossaryRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_glossary] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Wrap the response in an operation future. - response = operation.from_gapic( - response, - self._transport.operations_client, - translation_service.DeleteGlossaryResponse, - metadata_type=translation_service.DeleteGlossaryMetadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "TranslationServiceClient": - 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__) - - -__all__ = ( - "TranslationServiceClient", -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/pagers.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/pagers.py deleted file mode 100644 index 0af650a0..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/pagers.py +++ /dev/null @@ -1,139 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 typing import Any, AsyncIterator, Awaitable, Callable, Sequence, Tuple, Optional, Iterator - -from google.cloud.translate_v3beta1.types import translation_service - - -class ListGlossariesPager: - """A pager for iterating through ``list_glossaries`` requests. - - This class thinly wraps an initial - :class:`google.cloud.translate_v3beta1.types.ListGlossariesResponse` object, and - provides an ``__iter__`` method to iterate through its - ``glossaries`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListGlossaries`` requests and continue to iterate - through the ``glossaries`` field on the - corresponding responses. - - All the usual :class:`google.cloud.translate_v3beta1.types.ListGlossariesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., translation_service.ListGlossariesResponse], - request: translation_service.ListGlossariesRequest, - response: translation_service.ListGlossariesResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiate the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.translate_v3beta1.types.ListGlossariesRequest): - The initial request object. - response (google.cloud.translate_v3beta1.types.ListGlossariesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = translation_service.ListGlossariesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterator[translation_service.ListGlossariesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = self._method(self._request, metadata=self._metadata) - yield self._response - - def __iter__(self) -> Iterator[translation_service.Glossary]: - for page in self.pages: - yield from page.glossaries - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListGlossariesAsyncPager: - """A pager for iterating through ``list_glossaries`` requests. - - This class thinly wraps an initial - :class:`google.cloud.translate_v3beta1.types.ListGlossariesResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``glossaries`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListGlossaries`` requests and continue to iterate - through the ``glossaries`` field on the - corresponding responses. - - All the usual :class:`google.cloud.translate_v3beta1.types.ListGlossariesResponse` - attributes are available on the pager. If multiple requests are made, only - the most recent response is retained, and thus used for attribute lookup. - """ - def __init__(self, - method: Callable[..., Awaitable[translation_service.ListGlossariesResponse]], - request: translation_service.ListGlossariesRequest, - response: translation_service.ListGlossariesResponse, - *, - metadata: Sequence[Tuple[str, str]] = ()): - """Instantiates the pager. - - Args: - method (Callable): The method that was originally called, and - which instantiated this pager. - request (google.cloud.translate_v3beta1.types.ListGlossariesRequest): - The initial request object. - response (google.cloud.translate_v3beta1.types.ListGlossariesResponse): - The initial response object. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - self._method = method - self._request = translation_service.ListGlossariesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterator[translation_service.ListGlossariesResponse]: - yield self._response - while self._response.next_page_token: - self._request.page_token = self._response.next_page_token - self._response = await self._method(self._request, metadata=self._metadata) - yield self._response - def __aiter__(self) -> AsyncIterator[translation_service.Glossary]: - async def async_generator(): - async for page in self.pages: - for response in page.glossaries: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/__init__.py deleted file mode 100644 index 40bc74be..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslationServiceTransport -from .grpc import TranslationServiceGrpcTransport -from .grpc_asyncio import TranslationServiceGrpcAsyncIOTransport -from .rest import TranslationServiceRestTransport -from .rest import TranslationServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[TranslationServiceTransport]] -_transport_registry['grpc'] = TranslationServiceGrpcTransport -_transport_registry['grpc_asyncio'] = TranslationServiceGrpcAsyncIOTransport -_transport_registry['rest'] = TranslationServiceRestTransport - -__all__ = ( - 'TranslationServiceTransport', - 'TranslationServiceGrpcTransport', - 'TranslationServiceGrpcAsyncIOTransport', - 'TranslationServiceRestTransport', - 'TranslationServiceRestInterceptor', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/base.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/base.py deleted file mode 100644 index fd289181..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/base.py +++ /dev/null @@ -1,310 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.cloud.translate_v3beta1 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.api_core import operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.translate_v3beta1.types import translation_service -from google.longrunning import operations_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class TranslationServiceTransport(abc.ABC): - """Abstract transport class for TranslationService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', - ) - - DEFAULT_HOST: str = 'translate.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. - 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 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: - 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 - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.translate_text: gapic_v1.method.wrap_method( - self.translate_text, - default_timeout=600.0, - client_info=client_info, - ), - self.detect_language: gapic_v1.method.wrap_method( - self.detect_language, - default_timeout=600.0, - client_info=client_info, - ), - self.get_supported_languages: gapic_v1.method.wrap_method( - self.get_supported_languages, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.translate_document: gapic_v1.method.wrap_method( - self.translate_document, - default_timeout=600.0, - client_info=client_info, - ), - self.batch_translate_text: gapic_v1.method.wrap_method( - self.batch_translate_text, - default_timeout=600.0, - client_info=client_info, - ), - self.batch_translate_document: gapic_v1.method.wrap_method( - self.batch_translate_document, - default_timeout=600.0, - client_info=client_info, - ), - self.create_glossary: gapic_v1.method.wrap_method( - self.create_glossary, - default_timeout=600.0, - client_info=client_info, - ), - self.list_glossaries: gapic_v1.method.wrap_method( - self.list_glossaries, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.get_glossary: gapic_v1.method.wrap_method( - self.get_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.delete_glossary: gapic_v1.method.wrap_method( - self.delete_glossary, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - 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 operations_client(self): - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - Union[ - translation_service.TranslateTextResponse, - Awaitable[translation_service.TranslateTextResponse] - ]]: - raise NotImplementedError() - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - Union[ - translation_service.DetectLanguageResponse, - Awaitable[translation_service.DetectLanguageResponse] - ]]: - raise NotImplementedError() - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - Union[ - translation_service.SupportedLanguages, - Awaitable[translation_service.SupportedLanguages] - ]]: - raise NotImplementedError() - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - Union[ - translation_service.TranslateDocumentResponse, - Awaitable[translation_service.TranslateDocumentResponse] - ]]: - raise NotImplementedError() - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - Union[ - translation_service.ListGlossariesResponse, - Awaitable[translation_service.ListGlossariesResponse] - ]]: - raise NotImplementedError() - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - Union[ - translation_service.Glossary, - Awaitable[translation_service.Glossary] - ]]: - raise NotImplementedError() - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'TranslationServiceTransport', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc.py deleted file mode 100644 index f1fc7f93..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc.py +++ /dev/null @@ -1,541 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import operations_v1 -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 - -import grpc # type: ignore - -from google.cloud.translate_v3beta1.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO - - -class TranslationServiceGrpcTransport(TranslationServiceTransport): - """gRPC backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[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. - 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 ``channel`` 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 ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - 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 ``channel`` 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 ``channel`` 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] = {} - self._operations_client: Optional[operations_v1.OperationsClient] = None - - 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 channel: - # Ignore credentials if a channel was passed. - credentials = False - # 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: - self._grpc_channel = type(self).create_channel( - 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), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'translate.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 operations_client(self) -> operations_v1.OperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - translation_service.TranslateTextResponse]: - r"""Return a callable for the translate text method over gRPC. - - Translates input text and returns translated text. - - Returns: - Callable[[~.TranslateTextRequest], - ~.TranslateTextResponse]: - 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 'translate_text' not in self._stubs: - self._stubs['translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/TranslateText', - request_serializer=translation_service.TranslateTextRequest.serialize, - response_deserializer=translation_service.TranslateTextResponse.deserialize, - ) - return self._stubs['translate_text'] - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - translation_service.DetectLanguageResponse]: - r"""Return a callable for the detect language method over gRPC. - - Detects the language of text within a request. - - Returns: - Callable[[~.DetectLanguageRequest], - ~.DetectLanguageResponse]: - 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 'detect_language' not in self._stubs: - self._stubs['detect_language'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/DetectLanguage', - request_serializer=translation_service.DetectLanguageRequest.serialize, - response_deserializer=translation_service.DetectLanguageResponse.deserialize, - ) - return self._stubs['detect_language'] - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - translation_service.SupportedLanguages]: - r"""Return a callable for the get supported languages method over gRPC. - - Returns a list of supported languages for - translation. - - Returns: - Callable[[~.GetSupportedLanguagesRequest], - ~.SupportedLanguages]: - 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 'get_supported_languages' not in self._stubs: - self._stubs['get_supported_languages'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/GetSupportedLanguages', - request_serializer=translation_service.GetSupportedLanguagesRequest.serialize, - response_deserializer=translation_service.SupportedLanguages.deserialize, - ) - return self._stubs['get_supported_languages'] - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - translation_service.TranslateDocumentResponse]: - r"""Return a callable for the translate document method over gRPC. - - Translates documents in synchronous mode. - - Returns: - Callable[[~.TranslateDocumentRequest], - ~.TranslateDocumentResponse]: - 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 'translate_document' not in self._stubs: - self._stubs['translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/TranslateDocument', - request_serializer=translation_service.TranslateDocumentRequest.serialize, - response_deserializer=translation_service.TranslateDocumentResponse.deserialize, - ) - return self._stubs['translate_document'] - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - operations_pb2.Operation]: - r"""Return a callable for the batch translate text method over gRPC. - - Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - Returns: - Callable[[~.BatchTranslateTextRequest], - ~.Operation]: - 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 'batch_translate_text' not in self._stubs: - self._stubs['batch_translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/BatchTranslateText', - request_serializer=translation_service.BatchTranslateTextRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_text'] - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - operations_pb2.Operation]: - r"""Return a callable for the batch translate document method over gRPC. - - Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - Returns: - Callable[[~.BatchTranslateDocumentRequest], - ~.Operation]: - 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 'batch_translate_document' not in self._stubs: - self._stubs['batch_translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/BatchTranslateDocument', - request_serializer=translation_service.BatchTranslateDocumentRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_document'] - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - operations_pb2.Operation]: - r"""Return a callable for the create glossary method over gRPC. - - Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - Returns: - Callable[[~.CreateGlossaryRequest], - ~.Operation]: - 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_glossary' not in self._stubs: - self._stubs['create_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/CreateGlossary', - request_serializer=translation_service.CreateGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_glossary'] - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - translation_service.ListGlossariesResponse]: - r"""Return a callable for the list glossaries method over gRPC. - - Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - Returns: - Callable[[~.ListGlossariesRequest], - ~.ListGlossariesResponse]: - 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 'list_glossaries' not in self._stubs: - self._stubs['list_glossaries'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/ListGlossaries', - request_serializer=translation_service.ListGlossariesRequest.serialize, - response_deserializer=translation_service.ListGlossariesResponse.deserialize, - ) - return self._stubs['list_glossaries'] - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - translation_service.Glossary]: - r"""Return a callable for the get glossary method over gRPC. - - Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - Returns: - Callable[[~.GetGlossaryRequest], - ~.Glossary]: - 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 'get_glossary' not in self._stubs: - self._stubs['get_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/GetGlossary', - request_serializer=translation_service.GetGlossaryRequest.serialize, - response_deserializer=translation_service.Glossary.deserialize, - ) - return self._stubs['get_glossary'] - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - operations_pb2.Operation]: - r"""Return a callable for the delete glossary method over gRPC. - - Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - Returns: - Callable[[~.DeleteGlossaryRequest], - ~.Operation]: - 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 'delete_glossary' not in self._stubs: - self._stubs['delete_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/DeleteGlossary', - request_serializer=translation_service.DeleteGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_glossary'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'TranslationServiceGrpcTransport', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc_asyncio.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc_asyncio.py deleted file mode 100644 index 8f7a2037..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,540 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 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 operations_v1 -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.translate_v3beta1.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import TranslationServiceGrpcTransport - - -class TranslationServiceGrpcAsyncIOTransport(TranslationServiceTransport): - """gRPC AsyncIO backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.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`. - This argument is ignored if ``channel`` 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`. - 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 = 'translate.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[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. - 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 ``channel`` 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 ``channel`` 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[aio.Channel]): A ``Channel`` instance through - which to make calls. - 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 ``channel`` 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 ``channel`` 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] = {} - self._operations_client: Optional[operations_v1.OperationsAsyncClient] = None - - 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 channel: - # Ignore credentials if a channel was passed. - credentials = False - # 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: - self._grpc_channel = type(self).create_channel( - 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), - ], - ) - - # Wrap messages. This must be done after self._grpc_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 operations_client(self) -> operations_v1.OperationsAsyncClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Quick check: Only create a new client if we do not already have one. - if self._operations_client is None: - self._operations_client = operations_v1.OperationsAsyncClient( - self.grpc_channel - ) - - # Return the client from cache. - return self._operations_client - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - Awaitable[translation_service.TranslateTextResponse]]: - r"""Return a callable for the translate text method over gRPC. - - Translates input text and returns translated text. - - Returns: - Callable[[~.TranslateTextRequest], - Awaitable[~.TranslateTextResponse]]: - 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 'translate_text' not in self._stubs: - self._stubs['translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/TranslateText', - request_serializer=translation_service.TranslateTextRequest.serialize, - response_deserializer=translation_service.TranslateTextResponse.deserialize, - ) - return self._stubs['translate_text'] - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - Awaitable[translation_service.DetectLanguageResponse]]: - r"""Return a callable for the detect language method over gRPC. - - Detects the language of text within a request. - - Returns: - Callable[[~.DetectLanguageRequest], - Awaitable[~.DetectLanguageResponse]]: - 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 'detect_language' not in self._stubs: - self._stubs['detect_language'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/DetectLanguage', - request_serializer=translation_service.DetectLanguageRequest.serialize, - response_deserializer=translation_service.DetectLanguageResponse.deserialize, - ) - return self._stubs['detect_language'] - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - Awaitable[translation_service.SupportedLanguages]]: - r"""Return a callable for the get supported languages method over gRPC. - - Returns a list of supported languages for - translation. - - Returns: - Callable[[~.GetSupportedLanguagesRequest], - Awaitable[~.SupportedLanguages]]: - 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 'get_supported_languages' not in self._stubs: - self._stubs['get_supported_languages'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/GetSupportedLanguages', - request_serializer=translation_service.GetSupportedLanguagesRequest.serialize, - response_deserializer=translation_service.SupportedLanguages.deserialize, - ) - return self._stubs['get_supported_languages'] - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - Awaitable[translation_service.TranslateDocumentResponse]]: - r"""Return a callable for the translate document method over gRPC. - - Translates documents in synchronous mode. - - Returns: - Callable[[~.TranslateDocumentRequest], - Awaitable[~.TranslateDocumentResponse]]: - 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 'translate_document' not in self._stubs: - self._stubs['translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/TranslateDocument', - request_serializer=translation_service.TranslateDocumentRequest.serialize, - response_deserializer=translation_service.TranslateDocumentResponse.deserialize, - ) - return self._stubs['translate_document'] - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the batch translate text method over gRPC. - - Translates a large volume of text in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can - use google.longrunning.Operation.name to poll the status - of the call. - - Returns: - Callable[[~.BatchTranslateTextRequest], - Awaitable[~.Operation]]: - 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 'batch_translate_text' not in self._stubs: - self._stubs['batch_translate_text'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/BatchTranslateText', - request_serializer=translation_service.BatchTranslateTextRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_text'] - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the batch translate document method over gRPC. - - Translates a large volume of document in asynchronous - batch mode. This function provides real-time output as - the inputs are being processed. If caller cancels a - request, the partial results (for an input file, it's - all or nothing) may still be available on the specified - output location. - - This call returns immediately and you can use - google.longrunning.Operation.name to poll the status of - the call. - - Returns: - Callable[[~.BatchTranslateDocumentRequest], - Awaitable[~.Operation]]: - 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 'batch_translate_document' not in self._stubs: - self._stubs['batch_translate_document'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/BatchTranslateDocument', - request_serializer=translation_service.BatchTranslateDocumentRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['batch_translate_document'] - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the create glossary method over gRPC. - - Creates a glossary and returns the long-running operation. - Returns NOT_FOUND, if the project doesn't exist. - - Returns: - Callable[[~.CreateGlossaryRequest], - Awaitable[~.Operation]]: - 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_glossary' not in self._stubs: - self._stubs['create_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/CreateGlossary', - request_serializer=translation_service.CreateGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['create_glossary'] - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - Awaitable[translation_service.ListGlossariesResponse]]: - r"""Return a callable for the list glossaries method over gRPC. - - Lists glossaries in a project. Returns NOT_FOUND, if the project - doesn't exist. - - Returns: - Callable[[~.ListGlossariesRequest], - Awaitable[~.ListGlossariesResponse]]: - 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 'list_glossaries' not in self._stubs: - self._stubs['list_glossaries'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/ListGlossaries', - request_serializer=translation_service.ListGlossariesRequest.serialize, - response_deserializer=translation_service.ListGlossariesResponse.deserialize, - ) - return self._stubs['list_glossaries'] - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - Awaitable[translation_service.Glossary]]: - r"""Return a callable for the get glossary method over gRPC. - - Gets a glossary. Returns NOT_FOUND, if the glossary doesn't - exist. - - Returns: - Callable[[~.GetGlossaryRequest], - Awaitable[~.Glossary]]: - 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 'get_glossary' not in self._stubs: - self._stubs['get_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/GetGlossary', - request_serializer=translation_service.GetGlossaryRequest.serialize, - response_deserializer=translation_service.Glossary.deserialize, - ) - return self._stubs['get_glossary'] - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the delete glossary method over gRPC. - - Deletes a glossary, or cancels glossary construction if the - glossary isn't created yet. Returns NOT_FOUND, if the glossary - doesn't exist. - - Returns: - Callable[[~.DeleteGlossaryRequest], - Awaitable[~.Operation]]: - 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 'delete_glossary' not in self._stubs: - self._stubs['delete_glossary'] = self.grpc_channel.unary_unary( - '/google.cloud.translation.v3beta1.TranslationService/DeleteGlossary', - request_serializer=translation_service.DeleteGlossaryRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['delete_glossary'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'TranslationServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/rest.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/rest.py deleted file mode 100644 index bddca432..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/services/translation_service/transports/rest.py +++ /dev/null @@ -1,1421 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # 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 path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from google.api_core import operations_v1 -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - - -from google.cloud.translate_v3beta1.types import translation_service -from google.longrunning import operations_pb2 # type: ignore - -from .base import TranslationServiceTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class TranslationServiceRestInterceptor: - """Interceptor for TranslationService. - - 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 TranslationServiceRestTransport. - - .. code-block:: python - class MyCustomTranslationServiceInterceptor(TranslationServiceRestInterceptor): - def pre_batch_translate_document(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_batch_translate_document(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_batch_translate_text(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_batch_translate_text(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_create_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_delete_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_detect_language(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_detect_language(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_glossary(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_glossary(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_supported_languages(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_supported_languages(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_glossaries(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_glossaries(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_translate_document(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_translate_document(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_translate_text(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_translate_text(self, response): - logging.log(f"Received response: {response}") - return response - - transport = TranslationServiceRestTransport(interceptor=MyCustomTranslationServiceInterceptor()) - client = TranslationServiceClient(transport=transport) - - - """ - def pre_batch_translate_document(self, request: translation_service.BatchTranslateDocumentRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.BatchTranslateDocumentRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for batch_translate_document - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_batch_translate_document(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for batch_translate_document - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_batch_translate_text(self, request: translation_service.BatchTranslateTextRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.BatchTranslateTextRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for batch_translate_text - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_batch_translate_text(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for batch_translate_text - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_create_glossary(self, request: translation_service.CreateGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.CreateGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for create_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_create_glossary(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for create_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_delete_glossary(self, request: translation_service.DeleteGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.DeleteGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_delete_glossary(self, response: operations_pb2.Operation) -> operations_pb2.Operation: - """Post-rpc interceptor for delete_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_detect_language(self, request: translation_service.DetectLanguageRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.DetectLanguageRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for detect_language - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_detect_language(self, response: translation_service.DetectLanguageResponse) -> translation_service.DetectLanguageResponse: - """Post-rpc interceptor for detect_language - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_get_glossary(self, request: translation_service.GetGlossaryRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.GetGlossaryRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_glossary - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_get_glossary(self, response: translation_service.Glossary) -> translation_service.Glossary: - """Post-rpc interceptor for get_glossary - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_get_supported_languages(self, request: translation_service.GetSupportedLanguagesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.GetSupportedLanguagesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_supported_languages - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_get_supported_languages(self, response: translation_service.SupportedLanguages) -> translation_service.SupportedLanguages: - """Post-rpc interceptor for get_supported_languages - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_list_glossaries(self, request: translation_service.ListGlossariesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.ListGlossariesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_glossaries - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_list_glossaries(self, response: translation_service.ListGlossariesResponse) -> translation_service.ListGlossariesResponse: - """Post-rpc interceptor for list_glossaries - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_translate_document(self, request: translation_service.TranslateDocumentRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.TranslateDocumentRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for translate_document - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_translate_document(self, response: translation_service.TranslateDocumentResponse) -> translation_service.TranslateDocumentResponse: - """Post-rpc interceptor for translate_document - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - def pre_translate_text(self, request: translation_service.TranslateTextRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[translation_service.TranslateTextRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for translate_text - - Override in a subclass to manipulate the request or metadata - before they are sent to the TranslationService server. - """ - return request, metadata - - def post_translate_text(self, response: translation_service.TranslateTextResponse) -> translation_service.TranslateTextResponse: - """Post-rpc interceptor for translate_text - - Override in a subclass to manipulate the response - after it is returned by the TranslationService server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class TranslationServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: TranslationServiceRestInterceptor - - -class TranslationServiceRestTransport(TranslationServiceTransport): - """REST backend transport for TranslationService. - - Provides natural language translation operations. - - 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 = 'translate.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[TranslationServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - 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 - 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 - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - self._operations_client: Optional[operations_v1.AbstractOperationsClient] = None - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or TranslationServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - @property - def operations_client(self) -> operations_v1.AbstractOperationsClient: - """Create the client designed to process long-running operations. - - This property caches on the instance; repeated calls return the same - client. - """ - # Only create a new client if we do not already have one. - if self._operations_client is None: - http_options: Dict[str, List[Dict[str, str]]] = { - 'google.longrunning.Operations.CancelOperation': [ - { - 'method': 'post', - 'uri': '/v3beta1/{name=projects/*/locations/*/operations/*}:cancel', - 'body': '*', - }, - ], - 'google.longrunning.Operations.DeleteOperation': [ - { - 'method': 'delete', - 'uri': '/v3beta1/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.GetOperation': [ - { - 'method': 'get', - 'uri': '/v3beta1/{name=projects/*/locations/*/operations/*}', - }, - ], - 'google.longrunning.Operations.ListOperations': [ - { - 'method': 'get', - 'uri': '/v3beta1/{name=projects/*/locations/*}/operations', - }, - ], - 'google.longrunning.Operations.WaitOperation': [ - { - 'method': 'post', - 'uri': '/v3beta1/{name=projects/*/locations/*/operations/*}:wait', - 'body': '*', - }, - ], - } - - rest_transport = operations_v1.OperationsRestTransport( - host=self._host, - # use the credentials which are saved - credentials=self._credentials, - scopes=self._scopes, - http_options=http_options, - path_prefix="v3beta1") - - self._operations_client = operations_v1.AbstractOperationsClient(transport=rest_transport) - - # Return the client from cache. - return self._operations_client - - class _BatchTranslateDocument(TranslationServiceRestStub): - def __hash__(self): - return hash("BatchTranslateDocument") - - __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} - - def __call__(self, - request: translation_service.BatchTranslateDocumentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the batch translate document method over HTTP. - - Args: - request (~.translation_service.BatchTranslateDocumentRequest): - The request object. The BatchTranslateDocument request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}:batchTranslateDocument', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_batch_translate_document(request, metadata) - pb_request = translation_service.BatchTranslateDocumentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_batch_translate_document(resp) - return resp - - class _BatchTranslateText(TranslationServiceRestStub): - def __hash__(self): - return hash("BatchTranslateText") - - __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} - - def __call__(self, - request: translation_service.BatchTranslateTextRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the batch translate text method over HTTP. - - Args: - request (~.translation_service.BatchTranslateTextRequest): - The request object. The batch translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}:batchTranslateText', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_batch_translate_text(request, metadata) - pb_request = translation_service.BatchTranslateTextRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_batch_translate_text(resp) - return resp - - class _CreateGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("CreateGlossary") - - __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} - - def __call__(self, - request: translation_service.CreateGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the create glossary method over HTTP. - - Args: - request (~.translation_service.CreateGlossaryRequest): - The request object. Request message for CreateGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}/glossaries', - 'body': 'glossary', - }, - ] - request, metadata = self._interceptor.pre_create_glossary(request, metadata) - pb_request = translation_service.CreateGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_create_glossary(resp) - return resp - - class _DeleteGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("DeleteGlossary") - - __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} - - def __call__(self, - request: translation_service.DeleteGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> operations_pb2.Operation: - r"""Call the delete glossary method over HTTP. - - Args: - request (~.translation_service.DeleteGlossaryRequest): - The request object. Request message for DeleteGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.operations_pb2.Operation: - This resource represents a - long-running operation that is the - result of a network API call. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v3beta1/{name=projects/*/locations/*/glossaries/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_glossary(request, metadata) - pb_request = translation_service.DeleteGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = operations_pb2.Operation() - json_format.Parse(response.content, resp, ignore_unknown_fields=True) - resp = self._interceptor.post_delete_glossary(resp) - return resp - - class _DetectLanguage(TranslationServiceRestStub): - def __hash__(self): - return hash("DetectLanguage") - - __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} - - def __call__(self, - request: translation_service.DetectLanguageRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.DetectLanguageResponse: - r"""Call the detect language method over HTTP. - - Args: - request (~.translation_service.DetectLanguageRequest): - The request object. The request message for language - detection. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.DetectLanguageResponse: - The response message for language - detection. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}:detectLanguage', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*}:detectLanguage', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_detect_language(request, metadata) - pb_request = translation_service.DetectLanguageRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.DetectLanguageResponse() - pb_resp = translation_service.DetectLanguageResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_detect_language(resp) - return resp - - class _GetGlossary(TranslationServiceRestStub): - def __hash__(self): - return hash("GetGlossary") - - __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} - - def __call__(self, - request: translation_service.GetGlossaryRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.Glossary: - r"""Call the get glossary method over HTTP. - - Args: - request (~.translation_service.GetGlossaryRequest): - The request object. Request message for GetGlossary. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.Glossary: - Represents a glossary built from user - provided data. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3beta1/{name=projects/*/locations/*/glossaries/*}', - }, - ] - request, metadata = self._interceptor.pre_get_glossary(request, metadata) - pb_request = translation_service.GetGlossaryRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.Glossary() - pb_resp = translation_service.Glossary.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_glossary(resp) - return resp - - class _GetSupportedLanguages(TranslationServiceRestStub): - def __hash__(self): - return hash("GetSupportedLanguages") - - __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} - - def __call__(self, - request: translation_service.GetSupportedLanguagesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.SupportedLanguages: - r"""Call the get supported languages method over HTTP. - - Args: - request (~.translation_service.GetSupportedLanguagesRequest): - The request object. The request message for discovering - supported languages. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.SupportedLanguages: - The response message for discovering - supported languages. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3beta1/{parent=projects/*/locations/*}/supportedLanguages', - }, -{ - 'method': 'get', - 'uri': '/v3beta1/{parent=projects/*}/supportedLanguages', - }, - ] - request, metadata = self._interceptor.pre_get_supported_languages(request, metadata) - pb_request = translation_service.GetSupportedLanguagesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.SupportedLanguages() - pb_resp = translation_service.SupportedLanguages.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_supported_languages(resp) - return resp - - class _ListGlossaries(TranslationServiceRestStub): - def __hash__(self): - return hash("ListGlossaries") - - __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} - - def __call__(self, - request: translation_service.ListGlossariesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.ListGlossariesResponse: - r"""Call the list glossaries method over HTTP. - - Args: - request (~.translation_service.ListGlossariesRequest): - The request object. Request message for ListGlossaries. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.ListGlossariesResponse: - Response message for ListGlossaries. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v3beta1/{parent=projects/*/locations/*}/glossaries', - }, - ] - request, metadata = self._interceptor.pre_list_glossaries(request, metadata) - pb_request = translation_service.ListGlossariesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # 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 = translation_service.ListGlossariesResponse() - pb_resp = translation_service.ListGlossariesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_glossaries(resp) - return resp - - class _TranslateDocument(TranslationServiceRestStub): - def __hash__(self): - return hash("TranslateDocument") - - __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} - - def __call__(self, - request: translation_service.TranslateDocumentRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.TranslateDocumentResponse: - r"""Call the translate document method over HTTP. - - Args: - request (~.translation_service.TranslateDocumentRequest): - The request object. A document translation request. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.TranslateDocumentResponse: - A translated document response - message. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}:translateDocument', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_translate_document(request, metadata) - pb_request = translation_service.TranslateDocumentRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.TranslateDocumentResponse() - pb_resp = translation_service.TranslateDocumentResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_translate_document(resp) - return resp - - class _TranslateText(TranslationServiceRestStub): - def __hash__(self): - return hash("TranslateText") - - __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} - - def __call__(self, - request: translation_service.TranslateTextRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> translation_service.TranslateTextResponse: - r"""Call the translate text method over HTTP. - - Args: - request (~.translation_service.TranslateTextRequest): - The request object. The request message for synchronous - translation. - 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, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - ~.translation_service.TranslateTextResponse: - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*/locations/*}:translateText', - 'body': '*', - }, -{ - 'method': 'post', - 'uri': '/v3beta1/{parent=projects/*}:translateText', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_translate_text(request, metadata) - pb_request = translation_service.TranslateTextRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=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 = translation_service.TranslateTextResponse() - pb_resp = translation_service.TranslateTextResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_translate_text(resp) - return resp - - @property - def batch_translate_document(self) -> Callable[ - [translation_service.BatchTranslateDocumentRequest], - operations_pb2.Operation]: - # 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._BatchTranslateDocument(self._session, self._host, self._interceptor) # type: ignore - - @property - def batch_translate_text(self) -> Callable[ - [translation_service.BatchTranslateTextRequest], - operations_pb2.Operation]: - # 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._BatchTranslateText(self._session, self._host, self._interceptor) # type: ignore - - @property - def create_glossary(self) -> Callable[ - [translation_service.CreateGlossaryRequest], - operations_pb2.Operation]: - # 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._CreateGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_glossary(self) -> Callable[ - [translation_service.DeleteGlossaryRequest], - operations_pb2.Operation]: - # 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._DeleteGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def detect_language(self) -> Callable[ - [translation_service.DetectLanguageRequest], - translation_service.DetectLanguageResponse]: - # 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._DetectLanguage(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_glossary(self) -> Callable[ - [translation_service.GetGlossaryRequest], - translation_service.Glossary]: - # 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._GetGlossary(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_supported_languages(self) -> Callable[ - [translation_service.GetSupportedLanguagesRequest], - translation_service.SupportedLanguages]: - # 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._GetSupportedLanguages(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_glossaries(self) -> Callable[ - [translation_service.ListGlossariesRequest], - translation_service.ListGlossariesResponse]: - # 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._ListGlossaries(self._session, self._host, self._interceptor) # type: ignore - - @property - def translate_document(self) -> Callable[ - [translation_service.TranslateDocumentRequest], - translation_service.TranslateDocumentResponse]: - # 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._TranslateDocument(self._session, self._host, self._interceptor) # type: ignore - - @property - def translate_text(self) -> Callable[ - [translation_service.TranslateTextRequest], - translation_service.TranslateTextResponse]: - # 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._TranslateText(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'TranslationServiceRestTransport', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/__init__.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/__init__.py deleted file mode 100644 index 3218bd8e..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/__init__.py +++ /dev/null @@ -1,94 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 .translation_service import ( - BatchDocumentInputConfig, - BatchDocumentOutputConfig, - BatchTranslateDocumentMetadata, - BatchTranslateDocumentRequest, - BatchTranslateDocumentResponse, - BatchTranslateMetadata, - BatchTranslateResponse, - BatchTranslateTextRequest, - CreateGlossaryMetadata, - CreateGlossaryRequest, - DeleteGlossaryMetadata, - DeleteGlossaryRequest, - DeleteGlossaryResponse, - DetectedLanguage, - DetectLanguageRequest, - DetectLanguageResponse, - DocumentInputConfig, - DocumentOutputConfig, - DocumentTranslation, - GcsDestination, - GcsSource, - GetGlossaryRequest, - GetSupportedLanguagesRequest, - Glossary, - GlossaryInputConfig, - InputConfig, - ListGlossariesRequest, - ListGlossariesResponse, - OutputConfig, - SupportedLanguage, - SupportedLanguages, - TranslateDocumentRequest, - TranslateDocumentResponse, - TranslateTextGlossaryConfig, - TranslateTextRequest, - TranslateTextResponse, - Translation, -) - -__all__ = ( - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentMetadata', - 'BatchTranslateDocumentRequest', - 'BatchTranslateDocumentResponse', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'BatchTranslateTextRequest', - 'CreateGlossaryMetadata', - 'CreateGlossaryRequest', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryRequest', - 'DeleteGlossaryResponse', - 'DetectedLanguage', - 'DetectLanguageRequest', - 'DetectLanguageResponse', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'DocumentTranslation', - 'GcsDestination', - 'GcsSource', - 'GetGlossaryRequest', - 'GetSupportedLanguagesRequest', - 'Glossary', - 'GlossaryInputConfig', - 'InputConfig', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'OutputConfig', - 'SupportedLanguage', - 'SupportedLanguages', - 'TranslateDocumentRequest', - 'TranslateDocumentResponse', - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', -) diff --git a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/translation_service.py b/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/translation_service.py deleted file mode 100644 index 960702c8..00000000 --- a/owl-bot-staging/v3beta1/google/cloud/translate_v3beta1/types/translation_service.py +++ /dev/null @@ -1,2180 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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.protobuf import timestamp_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.translation.v3beta1', - manifest={ - 'TranslateTextGlossaryConfig', - 'TranslateTextRequest', - 'TranslateTextResponse', - 'Translation', - 'DetectLanguageRequest', - 'DetectedLanguage', - 'DetectLanguageResponse', - 'GetSupportedLanguagesRequest', - 'SupportedLanguages', - 'SupportedLanguage', - 'GcsSource', - 'InputConfig', - 'GcsDestination', - 'OutputConfig', - 'DocumentInputConfig', - 'DocumentOutputConfig', - 'TranslateDocumentRequest', - 'DocumentTranslation', - 'TranslateDocumentResponse', - 'BatchTranslateTextRequest', - 'BatchTranslateMetadata', - 'BatchTranslateResponse', - 'GlossaryInputConfig', - 'Glossary', - 'CreateGlossaryRequest', - 'GetGlossaryRequest', - 'DeleteGlossaryRequest', - 'ListGlossariesRequest', - 'ListGlossariesResponse', - 'CreateGlossaryMetadata', - 'DeleteGlossaryMetadata', - 'DeleteGlossaryResponse', - 'BatchTranslateDocumentRequest', - 'BatchDocumentInputConfig', - 'BatchDocumentOutputConfig', - 'BatchTranslateDocumentResponse', - 'BatchTranslateDocumentMetadata', - }, -) - - -class TranslateTextGlossaryConfig(proto.Message): - r"""Configures which glossary should be used for a specific - target language, and defines options for applying that glossary. - - Attributes: - glossary (str): - Required. Specifies the glossary used for this translation. - Use this format: projects/\ */locations/*/glossaries/\* - ignore_case (bool): - Optional. Indicates match is - case-insensitive. Default value is false if - missing. - """ - - glossary: str = proto.Field( - proto.STRING, - number=1, - ) - ignore_case: bool = proto.Field( - proto.BOOL, - number=2, - ) - - -class TranslateTextRequest(proto.Message): - r"""The request message for synchronous translation. - - Attributes: - contents (MutableSequence[str]): - Required. The content of the input in string - format. We recommend the total content be less - than 30k codepoints. The max length of this - field is 1024. - Use BatchTranslateText for larger text. - mime_type (str): - Optional. The format of the source text, for - example, "text/html", "text/plain". If left - blank, the MIME type defaults to "text/html". - source_language_code (str): - Optional. The BCP-47 language code of the - input text if known, for example, "en-US" or - "sr-Latn". Supported language codes are listed - in Language Support. If the source language - isn't specified, the API attempts to identify - the source language automatically and returns - the source language within the response. - target_language_code (str): - Required. The BCP-47 language code to use for - translation of the input text, set to one of the - language codes listed in Language Support. - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for requests using AutoML - models or custom glossaries. - - Models and glossaries must be within the same region (have - same location-id), otherwise an INVALID_ARGUMENT (400) error - is returned. - model (str): - Optional. The ``model`` type requested for this translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - For global (non-regionalized) requests, use ``location-id`` - ``global``. For example, - ``projects/{project-number-or-id}/locations/global/models/general/nmt``. - - If not provided, the default Google model (NMT) will be used - glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig): - Optional. Glossary to be applied. The glossary must be - within the same region (have the same location-id) as the - model, otherwise an INVALID_ARGUMENT (400) error is - returned. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/labels - for more information. - """ - - contents: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=4, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=5, - ) - parent: str = proto.Field( - proto.STRING, - number=8, - ) - model: str = proto.Field( - proto.STRING, - number=6, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=10, - ) - - -class TranslateTextResponse(proto.Message): - r""" - - Attributes: - translations (MutableSequence[google.cloud.translate_v3beta1.types.Translation]): - Text translation responses with no glossary applied. This - field has the same length as - [``contents``][google.cloud.translation.v3beta1.TranslateTextRequest.contents]. - glossary_translations (MutableSequence[google.cloud.translate_v3beta1.types.Translation]): - Text translation responses if a glossary is provided in the - request. This can be the same as - [``translations``][google.cloud.translation.v3beta1.TranslateTextResponse.translations] - if no terms apply. This field has the same length as - [``contents``][google.cloud.translation.v3beta1.TranslateTextRequest.contents]. - """ - - translations: MutableSequence['Translation'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Translation', - ) - glossary_translations: MutableSequence['Translation'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Translation', - ) - - -class Translation(proto.Message): - r"""A single translation response. - - Attributes: - translated_text (str): - Text translated into the target language. - If an error occurs during translation, this - field might be excluded from the response. - model (str): - Only present when ``model`` is present in the request. - ``model`` here is normalized to have project number. - - For example: If the ``model`` requested in - TranslationTextRequest is - ``projects/{project-id}/locations/{location-id}/models/general/nmt`` - then ``model`` here would be normalized to - ``projects/{project-number}/locations/{location-id}/models/general/nmt``. - detected_language_code (str): - The BCP-47 language code of source text in - the initial request, detected automatically, if - no source language was passed within the initial - request. If the source language was passed, - auto-detection of the language does not occur - and this field is empty. - glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig): - The ``glossary_config`` used for this translation. - """ - - translated_text: str = proto.Field( - proto.STRING, - number=1, - ) - model: str = proto.Field( - proto.STRING, - number=2, - ) - detected_language_code: str = proto.Field( - proto.STRING, - number=4, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=3, - message='TranslateTextGlossaryConfig', - ) - - -class DetectLanguageRequest(proto.Message): - r"""The request message for language detection. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}`` - or ``projects/{project-number-or-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Only models within the same region (has same location-id) - can be used. Otherwise an INVALID_ARGUMENT (400) error is - returned. - model (str): - Optional. The language detection model to be used. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`` - - Only one language detection model is currently supported: - ``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``. - - If not specified, the default model is used. - content (str): - The content of the input stored as a string. - - This field is a member of `oneof`_ ``source``. - mime_type (str): - Optional. The format of the source text, for - example, "text/html", "text/plain". If left - blank, the MIME type defaults to "text/html". - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/labels - for more information. - """ - - parent: str = proto.Field( - proto.STRING, - number=5, - ) - model: str = proto.Field( - proto.STRING, - number=4, - ) - content: str = proto.Field( - proto.STRING, - number=1, - oneof='source', - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - - -class DetectedLanguage(proto.Message): - r"""The response message for language detection. - - Attributes: - language_code (str): - The BCP-47 language code of source content in - the request, detected automatically. - confidence (float): - The confidence of the detection result for - this language. - """ - - language_code: str = proto.Field( - proto.STRING, - number=1, - ) - confidence: float = proto.Field( - proto.FLOAT, - number=2, - ) - - -class DetectLanguageResponse(proto.Message): - r"""The response message for language detection. - - Attributes: - languages (MutableSequence[google.cloud.translate_v3beta1.types.DetectedLanguage]): - A list of detected languages sorted by - detection confidence in descending order. The - most probable language first. - """ - - languages: MutableSequence['DetectedLanguage'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='DetectedLanguage', - ) - - -class GetSupportedLanguagesRequest(proto.Message): - r"""The request message for discovering supported languages. - - Attributes: - parent (str): - Required. Project or location to make a call. Must refer to - a caller's project. - - Format: ``projects/{project-number-or-id}`` or - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global`` or - ``projects/{project-number-or-id}``. - - Non-global location is required for AutoML models. - - Only models within the same region (have same location-id) - can be used, otherwise an INVALID_ARGUMENT (400) error is - returned. - display_language_code (str): - Optional. The language to use to return - localized, human readable names of supported - languages. If missing, then display names are - not returned in a response. - model (str): - Optional. Get supported languages of this model. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - Returns languages supported by the specified model. If - missing, we get supported languages of Google general NMT - model. - """ - - parent: str = proto.Field( - proto.STRING, - number=3, - ) - display_language_code: str = proto.Field( - proto.STRING, - number=1, - ) - model: str = proto.Field( - proto.STRING, - number=2, - ) - - -class SupportedLanguages(proto.Message): - r"""The response message for discovering supported languages. - - Attributes: - languages (MutableSequence[google.cloud.translate_v3beta1.types.SupportedLanguage]): - A list of supported language responses. This - list contains an entry for each language the - Translation API supports. - """ - - languages: MutableSequence['SupportedLanguage'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SupportedLanguage', - ) - - -class SupportedLanguage(proto.Message): - r"""A single supported language response corresponds to - information related to one supported language. - - Attributes: - language_code (str): - Supported language code, generally consisting - of its ISO 639-1 identifier, for example, 'en', - 'ja'. In certain cases, BCP-47 codes including - language and region identifiers are returned - (for example, 'zh-TW' and 'zh-CN') - display_name (str): - Human readable name of the language localized - in the display language specified in the - request. - support_source (bool): - Can be used as source language. - support_target (bool): - Can be used as target language. - """ - - language_code: str = proto.Field( - proto.STRING, - number=1, - ) - display_name: str = proto.Field( - proto.STRING, - number=2, - ) - support_source: bool = proto.Field( - proto.BOOL, - number=3, - ) - support_target: bool = proto.Field( - proto.BOOL, - number=4, - ) - - -class GcsSource(proto.Message): - r"""The Google Cloud Storage location for the input content. - - Attributes: - input_uri (str): - Required. Source data URI. For example, - ``gs://my_bucket/my_object``. - """ - - input_uri: str = proto.Field( - proto.STRING, - number=1, - ) - - -class InputConfig(proto.Message): - r"""Input configuration for BatchTranslateText request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - mime_type (str): - Optional. Can be "text/plain" or "text/html". For ``.tsv``, - "text/html" is used if mime_type is missing. For ``.html``, - this field must be "text/html" or empty. For ``.txt``, this - field must be "text/plain" or empty. - gcs_source (google.cloud.translate_v3beta1.types.GcsSource): - Required. Google Cloud Storage location for the source - input. This can be a single file (for example, - ``gs://translation-test/input.tsv``) or a wildcard (for - example, ``gs://translation-test/*``). If a file extension - is ``.tsv``, it can contain either one or two columns. The - first column (optional) is the id of the text request. If - the first column is missing, we use the row number (0-based) - from the input file as the ID in the output file. The second - column is the actual text to be translated. We recommend - each row be <= 10K Unicode codepoints, otherwise an error - might be returned. Note that the input tsv must be RFC 4180 - compliant. - - You could use https://github.com/Clever/csvlint to check - potential formatting errors in your tsv file. csvlint - --delimiter='\t' your_input_file.tsv - - The other supported file extensions are ``.txt`` or - ``.html``, which is treated as a single large chunk of text. - - This field is a member of `oneof`_ ``source``. - """ - - mime_type: str = proto.Field( - proto.STRING, - number=1, - ) - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=2, - oneof='source', - message='GcsSource', - ) - - -class GcsDestination(proto.Message): - r"""The Google Cloud Storage location for the output content. - - Attributes: - output_uri_prefix (str): - Required. There must be no files under 'output_uri_prefix'. - 'output_uri_prefix' must end with "/" and start with - "gs://", otherwise an INVALID_ARGUMENT (400) error is - returned. - """ - - output_uri_prefix: str = proto.Field( - proto.STRING, - number=1, - ) - - -class OutputConfig(proto.Message): - r"""Output configuration for BatchTranslateText request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3beta1.types.GcsDestination): - Google Cloud Storage destination for output content. For - every single input file (for example, - gs://a/b/c.[extension]), we generate at most 2 \* n output - files. (n is the # of target_language_codes in the - BatchTranslateTextRequest). - - Output files (tsv) generated are compliant with RFC 4180 - except that record delimiters are '\n' instead of '\r\n'. We - don't provide any way to change record delimiters. - - While the input files are being processed, we write/update - an index file 'index.csv' under 'output_uri_prefix' (for - example, gs://translation-test/index.csv) The index file is - generated/updated as new files are being translated. The - format is: - - input_file,target_language_code,translations_file,errors_file, - glossary_translations_file,glossary_errors_file - - input_file is one file we matched using - gcs_source.input_uri. target_language_code is provided in - the request. translations_file contains the translations. - (details provided below) errors_file contains the errors - during processing of the file. (details below). Both - translations_file and errors_file could be empty strings if - we have no content to output. glossary_translations_file and - glossary_errors_file are always empty strings if the - input_file is tsv. They could also be empty if we have no - content to output. - - Once a row is present in index.csv, the input/output - matching never changes. Callers should also expect all the - content in input_file are processed and ready to be consumed - (that is, no partial output file is written). - - Since index.csv will be keeping updated during the process, - please make sure there is no custom retention policy applied - on the output bucket that may avoid file updating. - (https://cloud.google.com/storage/docs/bucket-lock#retention-policy) - - The format of translations_file (for target language code - 'trg') is: - ``gs://translation_test/a_b_c_'trg'_translations.[extension]`` - - If the input file extension is tsv, the output has the - following columns: Column 1: ID of the request provided in - the input, if it's not provided in the input, then the input - row number is used (0-based). Column 2: source sentence. - Column 3: translation without applying a glossary. Empty - string if there is an error. Column 4 (only present if a - glossary is provided in the request): translation after - applying the glossary. Empty string if there is an error - applying the glossary. Could be same string as column 3 if - there is no glossary applied. - - If input file extension is a txt or html, the translation is - directly written to the output file. If glossary is - requested, a separate glossary_translations_file has format - of - ``gs://translation_test/a_b_c_'trg'_glossary_translations.[extension]`` - - The format of errors file (for target language code 'trg') - is: ``gs://translation_test/a_b_c_'trg'_errors.[extension]`` - - If the input file extension is tsv, errors_file contains the - following: Column 1: ID of the request provided in the - input, if it's not provided in the input, then the input row - number is used (0-based). Column 2: source sentence. Column - 3: Error detail for the translation. Could be empty. Column - 4 (only present if a glossary is provided in the request): - Error when applying the glossary. - - If the input file extension is txt or html, - glossary_error_file will be generated that contains error - details. glossary_error_file has format of - ``gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]`` - - This field is a member of `oneof`_ ``destination``. - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - - -class DocumentInputConfig(proto.Message): - r"""A document translation request input config. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - content (bytes): - Document's content represented as a stream of - bytes. - - This field is a member of `oneof`_ ``source``. - gcs_source (google.cloud.translate_v3beta1.types.GcsSource): - Google Cloud Storage location. This must be a single file. - For example: gs://example_bucket/example_file.pdf - - This field is a member of `oneof`_ ``source``. - mime_type (str): - Specifies the input document's mime_type. - - If not specified it will be determined using the file - extension for gcs_source provided files. For a file provided - through bytes content the mime_type must be provided. - Currently supported mime types are: - - - application/pdf - - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - application/vnd.openxmlformats-officedocument.presentationml.presentation - - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - """ - - content: bytes = proto.Field( - proto.BYTES, - number=1, - oneof='source', - ) - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=2, - oneof='source', - message='GcsSource', - ) - mime_type: str = proto.Field( - proto.STRING, - number=4, - ) - - -class DocumentOutputConfig(proto.Message): - r"""A document translation request output config. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3beta1.types.GcsDestination): - Optional. Google Cloud Storage destination for the - translation output, e.g., ``gs://my_bucket/my_directory/``. - - The destination directory provided does not have to be - empty, but the bucket must exist. If a file with the same - name as the output file already exists in the destination an - error will be returned. - - For a DocumentInputConfig.contents provided document, the - output file will have the name - "output_[trg]_translations.[ext]", where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - For a DocumentInputConfig.gcs_uri provided document, the - output file will have a name according to its URI. For - example: an input file with URI: ``gs://a/b/c.[extension]`` - stored in a gcs_destination bucket with name "my_bucket" - will have an output URI: - ``gs://my_bucket/a_b_c_[trg]_translations.[ext]``, where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - If the document was directly provided through the request, - then the output document will have the format: - ``gs://my_bucket/translated_document_[trg]_translations.[ext]``, - where - - - [trg] corresponds to the translated file's language code, - - [ext] corresponds to the translated file's extension - according to its mime type. - - If a glossary was provided, then the output URI for the - glossary translation will be equal to the default output URI - but have ``glossary_translations`` instead of - ``translations``. For the previous example, its glossary URI - would be: - ``gs://my_bucket/a_b_c_[trg]_glossary_translations.[ext]``. - - Thus the max number of output files will be 2 (Translated - document, Glossary translated document). - - Callers should expect no partial outputs. If there is any - error during document translation, no output will be stored - in the Cloud Storage bucket. - - This field is a member of `oneof`_ ``destination``. - mime_type (str): - Optional. Specifies the translated document's mime_type. If - not specified, the translated file's mime type will be the - same as the input file's mime type. Currently only support - the output mime type to be the same as input mime type. - - - application/pdf - - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - application/vnd.openxmlformats-officedocument.presentationml.presentation - - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - mime_type: str = proto.Field( - proto.STRING, - number=3, - ) - - -class TranslateDocumentRequest(proto.Message): - r"""A document translation request. - - Attributes: - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - For global calls, use - ``projects/{project-number-or-id}/locations/global``. - - Non-global location is required for requests using AutoML - models or custom glossaries. - - Models and glossaries must be within the same region (have - the same location-id), otherwise an INVALID_ARGUMENT (400) - error is returned. - source_language_code (str): - Optional. The BCP-47 language code of the - input document if known, for example, "en-US" or - "sr-Latn". Supported language codes are listed - in Language Support. If the source language - isn't specified, the API attempts to identify - the source language automatically and returns - the source language within the response. Source - language must be specified if the request - contains a glossary or a custom model. - target_language_code (str): - Required. The BCP-47 language code to use for - translation of the input document, set to one of - the language codes listed in Language Support. - document_input_config (google.cloud.translate_v3beta1.types.DocumentInputConfig): - Required. Input configurations. - document_output_config (google.cloud.translate_v3beta1.types.DocumentOutputConfig): - Optional. Output configurations. - Defines if the output file should be stored - within Cloud Storage as well as the desired - output format. If not provided the translated - file will only be returned through a byte-stream - and its output mime type will be the same as the - input file's mime type. - model (str): - Optional. The ``model`` type requested for this translation. - - The format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If not provided, the default Google model (NMT) will be used - for translation. - glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig): - Optional. Glossary to be applied. The glossary must be - within the same region (have the same location-id) as the - model, otherwise an INVALID_ARGUMENT (400) error is - returned. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/advanced/labels - for more information. - customized_attribution (str): - Optional. This flag is to support user customized - attribution. If not provided, the default is - ``Machine Translated by Google``. Customized attribution - should follow rules in - https://cloud.google.com/translate/attribution#attribution_and_logos - is_translate_native_pdf_only (bool): - Optional. is_translate_native_pdf_only field for external - customers. If true, the page limit of online native pdf - translation is 300 and only native pdf pages will be - translated. - enable_shadow_removal_native_pdf (bool): - Optional. If true, use the text removal server to remove the - shadow text on background image for native pdf translation. - Shadow removal feature can only be enabled when - is_translate_native_pdf_only: false && pdf_native_only: - false - enable_rotation_correction (bool): - Optional. If true, enable auto rotation - correction in DVS. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=3, - ) - document_input_config: 'DocumentInputConfig' = proto.Field( - proto.MESSAGE, - number=4, - message='DocumentInputConfig', - ) - document_output_config: 'DocumentOutputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='DocumentOutputConfig', - ) - model: str = proto.Field( - proto.STRING, - number=6, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=8, - ) - customized_attribution: str = proto.Field( - proto.STRING, - number=10, - ) - is_translate_native_pdf_only: bool = proto.Field( - proto.BOOL, - number=11, - ) - enable_shadow_removal_native_pdf: bool = proto.Field( - proto.BOOL, - number=12, - ) - enable_rotation_correction: bool = proto.Field( - proto.BOOL, - number=13, - ) - - -class DocumentTranslation(proto.Message): - r"""A translated document message. - - Attributes: - byte_stream_outputs (MutableSequence[bytes]): - The array of translated documents. It is - expected to be size 1 for now. We may produce - multiple translated documents in the future for - other type of file formats. - mime_type (str): - The translated document's mime type. - detected_language_code (str): - The detected language for the input document. - If the user did not provide the source language - for the input document, this field will have the - language code automatically detected. If the - source language was passed, auto-detection of - the language does not occur and this field is - empty. - """ - - byte_stream_outputs: MutableSequence[bytes] = proto.RepeatedField( - proto.BYTES, - number=1, - ) - mime_type: str = proto.Field( - proto.STRING, - number=2, - ) - detected_language_code: str = proto.Field( - proto.STRING, - number=3, - ) - - -class TranslateDocumentResponse(proto.Message): - r"""A translated document response message. - - Attributes: - document_translation (google.cloud.translate_v3beta1.types.DocumentTranslation): - Translated document. - glossary_document_translation (google.cloud.translate_v3beta1.types.DocumentTranslation): - The document's translation output if a glossary is provided - in the request. This can be the same as - [TranslateDocumentResponse.document_translation] if no - glossary terms apply. - model (str): - Only present when 'model' is present in the request. 'model' - is normalized to have a project number. - - For example: If the 'model' field in - TranslateDocumentRequest is: - ``projects/{project-id}/locations/{location-id}/models/general/nmt`` - then ``model`` here would be normalized to - ``projects/{project-number}/locations/{location-id}/models/general/nmt``. - glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig): - The ``glossary_config`` used for this translation. - """ - - document_translation: 'DocumentTranslation' = proto.Field( - proto.MESSAGE, - number=1, - message='DocumentTranslation', - ) - glossary_document_translation: 'DocumentTranslation' = proto.Field( - proto.MESSAGE, - number=2, - message='DocumentTranslation', - ) - model: str = proto.Field( - proto.STRING, - number=3, - ) - glossary_config: 'TranslateTextGlossaryConfig' = proto.Field( - proto.MESSAGE, - number=4, - message='TranslateTextGlossaryConfig', - ) - - -class BatchTranslateTextRequest(proto.Message): - r"""The batch translation request. - - Attributes: - parent (str): - Required. Location to make a call. Must refer to a caller's - project. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the same - region (have the same location-id) can be used, otherwise an - INVALID_ARGUMENT (400) error is returned. - source_language_code (str): - Required. Source language code. - target_language_codes (MutableSequence[str]): - Required. Specify up to 10 language codes - here. - models (MutableMapping[str, str]): - Optional. The models to use for translation. Map's key is - target language code. Map's value is model name. Value can - be a built-in general model, or an AutoML Translation model. - - The value format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If the map is empty or a specific model is not requested for - a language pair, then default google model (nmt) is used. - input_configs (MutableSequence[google.cloud.translate_v3beta1.types.InputConfig]): - Required. Input configurations. - The total number of files matched should be <= - 100. The total content size should be <= 100M - Unicode codepoints. The files must use UTF-8 - encoding. - output_config (google.cloud.translate_v3beta1.types.OutputConfig): - Required. Output configuration. - If 2 input configs match to the same file (that - is, same input path), we don't generate output - for duplicate inputs. - glossaries (MutableMapping[str, google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig]): - Optional. Glossaries to be applied for - translation. It's keyed by target language code. - labels (MutableMapping[str, str]): - Optional. The labels with user-defined - metadata for the request. - Label keys and values can be no longer than 63 - characters (Unicode codepoints), can only - contain lowercase letters, numeric characters, - underscores and dashes. International characters - are allowed. Label values are optional. Label - keys must start with a letter. - - See - https://cloud.google.com/translate/docs/labels - for more information. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - models: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=4, - ) - input_configs: MutableSequence['InputConfig'] = proto.RepeatedField( - proto.MESSAGE, - number=5, - message='InputConfig', - ) - output_config: 'OutputConfig' = proto.Field( - proto.MESSAGE, - number=6, - message='OutputConfig', - ) - glossaries: MutableMapping[str, 'TranslateTextGlossaryConfig'] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - labels: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=9, - ) - - -class BatchTranslateMetadata(proto.Message): - r"""State metadata for the batch translation operation. - - Attributes: - state (google.cloud.translate_v3beta1.types.BatchTranslateMetadata.State): - The state of the operation. - translated_characters (int): - Number of successfully translated characters - so far (Unicode codepoints). - failed_characters (int): - Number of characters that have failed to - process so far (Unicode codepoints). - total_characters (int): - Total number of characters (Unicode - codepoints). This is the total number of - codepoints from input files times the number of - target languages and appears here shortly after - the call is submitted. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - """ - class State(proto.Enum): - r"""State of the job. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The batch is processed, and at least one item - was successfully processed. - FAILED (3): - The batch is done and no item was - successfully processed. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The batch is done after the user has called - the longrunning.Operations.CancelOperation. Any - records processed before the cancel command are - output as specified in the request. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - state: State = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=2, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=3, - ) - total_characters: int = proto.Field( - proto.INT64, - number=4, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateText if at least one sentence is - translated successfully. - - Attributes: - total_characters (int): - Total number of characters (Unicode - codepoints). - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints). - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints). - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - total_characters: int = proto.Field( - proto.INT64, - number=1, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=2, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=3, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=4, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=5, - message=timestamp_pb2.Timestamp, - ) - - -class GlossaryInputConfig(proto.Message): - r"""Input configuration for glossaries. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_source (google.cloud.translate_v3beta1.types.GcsSource): - Required. Google Cloud Storage location of glossary data. - File format is determined based on the filename extension. - API returns [google.rpc.Code.INVALID_ARGUMENT] for - unsupported URI-s and file formats. Wildcards are not - allowed. This must be a single file in one of the following - formats: - - For unidirectional glossaries: - - - TSV/CSV (``.tsv``/``.csv``): 2 column file, tab- or - comma-separated. The first column is source text. The - second column is target text. The file must not contain - headers. That is, the first row is data, not column - names. - - - TMX (``.tmx``): TMX file with parallel data defining - source/target term pairs. - - For equivalent term sets glossaries: - - - CSV (``.csv``): Multi-column CSV file defining equivalent - glossary terms in multiple languages. See documentation - for more information - - `glossaries `__. - - This field is a member of `oneof`_ ``source``. - """ - - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=1, - oneof='source', - message='GcsSource', - ) - - -class Glossary(proto.Message): - r"""Represents a glossary built from user provided data. - - This message has `oneof`_ fields (mutually exclusive fields). - For each oneof, at most one member field can be set at the same time. - Setting any member of the oneof automatically clears all other - members. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - name (str): - Required. The resource name of the glossary. Glossary names - have the form - ``projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}``. - language_pair (google.cloud.translate_v3beta1.types.Glossary.LanguageCodePair): - Used with unidirectional glossaries. - - This field is a member of `oneof`_ ``languages``. - language_codes_set (google.cloud.translate_v3beta1.types.Glossary.LanguageCodesSet): - Used with equivalent term set glossaries. - - This field is a member of `oneof`_ ``languages``. - input_config (google.cloud.translate_v3beta1.types.GlossaryInputConfig): - Required. Provides examples to build the - glossary from. Total glossary must not exceed - 10M Unicode codepoints. - entry_count (int): - Output only. The number of entries defined in - the glossary. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. When CreateGlossary was called. - end_time (google.protobuf.timestamp_pb2.Timestamp): - Output only. When the glossary creation was - finished. - """ - - class LanguageCodePair(proto.Message): - r"""Used with unidirectional glossaries. - - Attributes: - source_language_code (str): - Required. The BCP-47 language code of the input text, for - example, "en-US". Expected to be an exact match for - GlossaryTerm.language_code. - target_language_code (str): - Required. The BCP-47 language code for translation output, - for example, "zh-CN". Expected to be an exact match for - GlossaryTerm.language_code. - """ - - source_language_code: str = proto.Field( - proto.STRING, - number=1, - ) - target_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - - class LanguageCodesSet(proto.Message): - r"""Used with equivalent term set glossaries. - - Attributes: - language_codes (MutableSequence[str]): - The BCP-47 language code(s) for terms defined in the - glossary. All entries are unique. The list contains at least - two entries. Expected to be an exact match for - GlossaryTerm.language_code. - """ - - language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=1, - ) - - name: str = proto.Field( - proto.STRING, - number=1, - ) - language_pair: LanguageCodePair = proto.Field( - proto.MESSAGE, - number=3, - oneof='languages', - message=LanguageCodePair, - ) - language_codes_set: LanguageCodesSet = proto.Field( - proto.MESSAGE, - number=4, - oneof='languages', - message=LanguageCodesSet, - ) - input_config: 'GlossaryInputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='GlossaryInputConfig', - ) - entry_count: int = proto.Field( - proto.INT32, - number=6, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=7, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=8, - message=timestamp_pb2.Timestamp, - ) - - -class CreateGlossaryRequest(proto.Message): - r"""Request message for CreateGlossary. - - Attributes: - parent (str): - Required. The project name. - glossary (google.cloud.translate_v3beta1.types.Glossary): - Required. The glossary to create. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - glossary: 'Glossary' = proto.Field( - proto.MESSAGE, - number=2, - message='Glossary', - ) - - -class GetGlossaryRequest(proto.Message): - r"""Request message for GetGlossary. - - Attributes: - name (str): - Required. The name of the glossary to - retrieve. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteGlossaryRequest(proto.Message): - r"""Request message for DeleteGlossary. - - Attributes: - name (str): - Required. The name of the glossary to delete. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ListGlossariesRequest(proto.Message): - r"""Request message for ListGlossaries. - - Attributes: - parent (str): - Required. The name of the project from which - to list all of the glossaries. - page_size (int): - Optional. Requested page size. The server may - return fewer glossaries than requested. If - unspecified, the server picks an appropriate - default. - page_token (str): - Optional. A token identifying a page of results the server - should return. Typically, this is the value of - [ListGlossariesResponse.next_page_token] returned from the - previous call to ``ListGlossaries`` method. The first page - is returned if ``page_token``\ is empty or missing. - filter (str): - Optional. Filter specifying constraints of a - list operation. Specify the constraint by the - format of "key=value", where key must be "src" - or "tgt", and the value must be a valid language - code. For multiple restrictions, concatenate - them by "AND" (uppercase only), such as: - "src=en-US AND tgt=zh-CN". Notice that the exact - match is used here, which means using 'en-US' - and 'en' can lead to different results, which - depends on the language code you used when you - create the glossary. For the unidirectional - glossaries, the "src" and "tgt" add restrictions - on the source and target language code - separately. For the equivalent term set - glossaries, the "src" and/or "tgt" add - restrictions on the term set. - For example: "src=en-US AND tgt=zh-CN" will only - pick the unidirectional glossaries which exactly - match the source language code as "en-US" and - the target language code "zh-CN", but all - equivalent term set glossaries which contain - "en-US" and "zh-CN" in their language set will - be picked. If missing, no filtering is - performed. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - page_size: int = proto.Field( - proto.INT32, - number=2, - ) - page_token: str = proto.Field( - proto.STRING, - number=3, - ) - filter: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListGlossariesResponse(proto.Message): - r"""Response message for ListGlossaries. - - Attributes: - glossaries (MutableSequence[google.cloud.translate_v3beta1.types.Glossary]): - The list of glossaries for a project. - next_page_token (str): - A token to retrieve a page of results. Pass this value in - the [ListGlossariesRequest.page_token] field in the - subsequent call to ``ListGlossaries`` method to retrieve the - next page of results. - """ - - @property - def raw_page(self): - return self - - glossaries: MutableSequence['Glossary'] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='Glossary', - ) - next_page_token: str = proto.Field( - proto.STRING, - number=2, - ) - - -class CreateGlossaryMetadata(proto.Message): - r"""Stored in the - [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] - field returned by CreateGlossary. - - Attributes: - name (str): - The name of the glossary that is being - created. - state (google.cloud.translate_v3beta1.types.CreateGlossaryMetadata.State): - The current state of the glossary creation - operation. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - """ - class State(proto.Enum): - r"""Enumerates the possible states that the creation request can - be in. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The glossary was successfully created. - FAILED (3): - Failed to create the glossary. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The glossary creation request was - successfully canceled. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - state: State = proto.Field( - proto.ENUM, - number=2, - enum=State, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class DeleteGlossaryMetadata(proto.Message): - r"""Stored in the - [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] - field returned by DeleteGlossary. - - Attributes: - name (str): - The name of the glossary that is being - deleted. - state (google.cloud.translate_v3beta1.types.DeleteGlossaryMetadata.State): - The current state of the glossary deletion - operation. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - """ - class State(proto.Enum): - r"""Enumerates the possible states that the creation request can - be in. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The glossary was successfully deleted. - FAILED (3): - Failed to delete the glossary. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The glossary deletion request was - successfully canceled. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - name: str = proto.Field( - proto.STRING, - number=1, - ) - state: State = proto.Field( - proto.ENUM, - number=2, - enum=State, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class DeleteGlossaryResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by DeleteGlossary. - - Attributes: - name (str): - The name of the deleted glossary. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation was submitted to - the server. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the glossary deletion is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateDocumentRequest(proto.Message): - r"""The BatchTranslateDocument request. - - Attributes: - parent (str): - Required. Location to make a regional call. - - Format: - ``projects/{project-number-or-id}/locations/{location-id}``. - - The ``global`` location is not supported for batch - translation. - - Only AutoML Translation models or glossaries within the same - region (have the same location-id) can be used, otherwise an - INVALID_ARGUMENT (400) error is returned. - source_language_code (str): - Required. The BCP-47 language code of the input document if - known, for example, "en-US" or "sr-Latn". Supported language - codes are listed in `Language - Support `__. - target_language_codes (MutableSequence[str]): - Required. The BCP-47 language code to use for - translation of the input document. Specify up to - 10 language codes here. - input_configs (MutableSequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]): - Required. Input configurations. - The total number of files matched should be <= - 100. The total content size to translate should - be <= 100M Unicode codepoints. The files must - use UTF-8 encoding. - output_config (google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig): - Required. Output configuration. - If 2 input configs match to the same file (that - is, same input path), we don't generate output - for duplicate inputs. - models (MutableMapping[str, str]): - Optional. The models to use for translation. Map's key is - target language code. Map's value is the model name. Value - can be a built-in general model, or an AutoML Translation - model. - - The value format depends on model type: - - - AutoML Translation models: - ``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`` - - - General (built-in) models: - ``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``, - - If the map is empty or a specific model is not requested for - a language pair, then default google model (nmt) is used. - glossaries (MutableMapping[str, google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig]): - Optional. Glossaries to be applied. It's - keyed by target language code. - format_conversions (MutableMapping[str, str]): - Optional. File format conversion map to be applied to all - input files. Map's key is the original mime_type. Map's - value is the target mime_type of translated documents. - - Supported file format conversion includes: - - - ``application/pdf`` to - ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` - - If nothing specified, output files will be in the same - format as the original file. - customized_attribution (str): - Optional. This flag is to support user customized - attribution. If not provided, the default is - ``Machine Translated by Google``. Customized attribution - should follow rules in - https://cloud.google.com/translate/attribution#attribution_and_logos - enable_shadow_removal_native_pdf (bool): - Optional. If true, use the text removal server to remove the - shadow text on background image for native pdf translation. - Shadow removal feature can only be enabled when - is_translate_native_pdf_only: false && pdf_native_only: - false - enable_rotation_correction (bool): - Optional. If true, enable auto rotation - correction in DVS. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - source_language_code: str = proto.Field( - proto.STRING, - number=2, - ) - target_language_codes: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=3, - ) - input_configs: MutableSequence['BatchDocumentInputConfig'] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message='BatchDocumentInputConfig', - ) - output_config: 'BatchDocumentOutputConfig' = proto.Field( - proto.MESSAGE, - number=5, - message='BatchDocumentOutputConfig', - ) - models: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=6, - ) - glossaries: MutableMapping[str, 'TranslateTextGlossaryConfig'] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=7, - message='TranslateTextGlossaryConfig', - ) - format_conversions: MutableMapping[str, str] = proto.MapField( - proto.STRING, - proto.STRING, - number=8, - ) - customized_attribution: str = proto.Field( - proto.STRING, - number=10, - ) - enable_shadow_removal_native_pdf: bool = proto.Field( - proto.BOOL, - number=11, - ) - enable_rotation_correction: bool = proto.Field( - proto.BOOL, - number=12, - ) - - -class BatchDocumentInputConfig(proto.Message): - r"""Input configuration for BatchTranslateDocument request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_source (google.cloud.translate_v3beta1.types.GcsSource): - Google Cloud Storage location for the source input. This can - be a single file (for example, - ``gs://translation-test/input.docx``) or a wildcard (for - example, ``gs://translation-test/*``). - - File mime type is determined based on extension. Supported - mime type includes: - - - ``pdf``, application/pdf - - ``docx``, - application/vnd.openxmlformats-officedocument.wordprocessingml.document - - ``pptx``, - application/vnd.openxmlformats-officedocument.presentationml.presentation - - ``xlsx``, - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - - The max file size to support for ``.docx``, ``.pptx`` and - ``.xlsx`` is 100MB. The max file size to support for - ``.pdf`` is 1GB and the max page limit is 1000 pages. The - max file size to support for all input documents is 1GB. - - This field is a member of `oneof`_ ``source``. - """ - - gcs_source: 'GcsSource' = proto.Field( - proto.MESSAGE, - number=1, - oneof='source', - message='GcsSource', - ) - - -class BatchDocumentOutputConfig(proto.Message): - r"""Output configuration for BatchTranslateDocument request. - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - gcs_destination (google.cloud.translate_v3beta1.types.GcsDestination): - Google Cloud Storage destination for output content. For - every single input document (for example, - gs://a/b/c.[extension]), we generate at most 2 \* n output - files. (n is the # of target_language_codes in the - BatchTranslateDocumentRequest). - - While the input documents are being processed, we - write/update an index file ``index.csv`` under - ``gcs_destination.output_uri_prefix`` (for example, - gs://translation_output/index.csv) The index file is - generated/updated as new files are being translated. The - format is: - - input_document,target_language_code,translation_output,error_output, - glossary_translation_output,glossary_error_output - - ``input_document`` is one file we matched using - gcs_source.input_uri. ``target_language_code`` is provided - in the request. ``translation_output`` contains the - translations. (details provided below) ``error_output`` - contains the error message during processing of the file. - Both translations_file and errors_file could be empty - strings if we have no content to output. - ``glossary_translation_output`` and - ``glossary_error_output`` are the translated output/error - when we apply glossaries. They could also be empty if we - have no content to output. - - Once a row is present in index.csv, the input/output - matching never changes. Callers should also expect all the - content in input_file are processed and ready to be consumed - (that is, no partial output file is written). - - Since index.csv will be keeping updated during the process, - please make sure there is no custom retention policy applied - on the output bucket that may avoid file updating. - (https://cloud.google.com/storage/docs/bucket-lock#retention-policy) - - The naming format of translation output files follows (for - target language code [trg]): ``translation_output``: - ``gs://translation_output/a_b_c_[trg]_translation.[extension]`` - ``glossary_translation_output``: - ``gs://translation_test/a_b_c_[trg]_glossary_translation.[extension]``. - The output document will maintain the same file format as - the input document. - - The naming format of error output files follows (for target - language code [trg]): ``error_output``: - ``gs://translation_test/a_b_c_[trg]_errors.txt`` - ``glossary_error_output``: - ``gs://translation_test/a_b_c_[trg]_glossary_translation.txt`` - The error output is a txt file containing error details. - - This field is a member of `oneof`_ ``destination``. - """ - - gcs_destination: 'GcsDestination' = proto.Field( - proto.MESSAGE, - number=1, - oneof='destination', - message='GcsDestination', - ) - - -class BatchTranslateDocumentResponse(proto.Message): - r"""Stored in the - [google.longrunning.Operation.response][google.longrunning.Operation.response] - field returned by BatchTranslateDocument if at least one document is - translated successfully. - - Attributes: - total_pages (int): - Total number of pages to translate in all - documents. Documents without clear page - definition (such as XLSX) are not counted. - translated_pages (int): - Number of successfully translated pages in - all documents. Documents without clear page - definition (such as XLSX) are not counted. - failed_pages (int): - Number of pages that failed to process in all - documents. Documents without clear page - definition (such as XLSX) are not counted. - total_billable_pages (int): - Number of billable pages in documents with - clear page definition (such as PDF, DOCX, PPTX) - total_characters (int): - Total number of characters (Unicode - codepoints) in all documents. - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints) in all documents. - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints) in all documents. - total_billable_characters (int): - Number of billable characters (Unicode - codepoints) in documents without clear page - definition, such as XLSX. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - end_time (google.protobuf.timestamp_pb2.Timestamp): - The time when the operation is finished and - [google.longrunning.Operation.done][google.longrunning.Operation.done] - is set to true. - """ - - total_pages: int = proto.Field( - proto.INT64, - number=1, - ) - translated_pages: int = proto.Field( - proto.INT64, - number=2, - ) - failed_pages: int = proto.Field( - proto.INT64, - number=3, - ) - total_billable_pages: int = proto.Field( - proto.INT64, - number=4, - ) - total_characters: int = proto.Field( - proto.INT64, - number=5, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=6, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=7, - ) - total_billable_characters: int = proto.Field( - proto.INT64, - number=8, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=9, - message=timestamp_pb2.Timestamp, - ) - end_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=10, - message=timestamp_pb2.Timestamp, - ) - - -class BatchTranslateDocumentMetadata(proto.Message): - r"""State metadata for the batch translation operation. - - Attributes: - state (google.cloud.translate_v3beta1.types.BatchTranslateDocumentMetadata.State): - The state of the operation. - total_pages (int): - Total number of pages to translate in all - documents so far. Documents without clear page - definition (such as XLSX) are not counted. - translated_pages (int): - Number of successfully translated pages in - all documents so far. Documents without clear - page definition (such as XLSX) are not counted. - failed_pages (int): - Number of pages that failed to process in all - documents so far. Documents without clear page - definition (such as XLSX) are not counted. - total_billable_pages (int): - Number of billable pages in documents with - clear page definition (such as PDF, DOCX, PPTX) - so far. - total_characters (int): - Total number of characters (Unicode - codepoints) in all documents so far. - translated_characters (int): - Number of successfully translated characters - (Unicode codepoints) in all documents so far. - failed_characters (int): - Number of characters that have failed to - process (Unicode codepoints) in all documents so - far. - total_billable_characters (int): - Number of billable characters (Unicode - codepoints) in documents without clear page - definition (such as XLSX) so far. - submit_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the operation was submitted. - """ - class State(proto.Enum): - r"""State of the job. - - Values: - STATE_UNSPECIFIED (0): - Invalid. - RUNNING (1): - Request is being processed. - SUCCEEDED (2): - The batch is processed, and at least one item - was successfully processed. - FAILED (3): - The batch is done and no item was - successfully processed. - CANCELLING (4): - Request is in the process of being canceled - after caller invoked - longrunning.Operations.CancelOperation on the - request id. - CANCELLED (5): - The batch is done after the user has called - the longrunning.Operations.CancelOperation. Any - records processed before the cancel command are - output as specified in the request. - """ - STATE_UNSPECIFIED = 0 - RUNNING = 1 - SUCCEEDED = 2 - FAILED = 3 - CANCELLING = 4 - CANCELLED = 5 - - state: State = proto.Field( - proto.ENUM, - number=1, - enum=State, - ) - total_pages: int = proto.Field( - proto.INT64, - number=2, - ) - translated_pages: int = proto.Field( - proto.INT64, - number=3, - ) - failed_pages: int = proto.Field( - proto.INT64, - number=4, - ) - total_billable_pages: int = proto.Field( - proto.INT64, - number=5, - ) - total_characters: int = proto.Field( - proto.INT64, - number=6, - ) - translated_characters: int = proto.Field( - proto.INT64, - number=7, - ) - failed_characters: int = proto.Field( - proto.INT64, - number=8, - ) - total_billable_characters: int = proto.Field( - proto.INT64, - number=9, - ) - submit_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=10, - message=timestamp_pb2.Timestamp, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v3beta1/mypy.ini b/owl-bot-staging/v3beta1/mypy.ini deleted file mode 100644 index 574c5aed..00000000 --- a/owl-bot-staging/v3beta1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v3beta1/noxfile.py b/owl-bot-staging/v3beta1/noxfile.py deleted file mode 100644 index 3a8e299c..00000000 --- a/owl-bot-staging/v3beta1/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/translate_v3beta1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - '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 docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==7.0.1", "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=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", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/snippet_metadata_google.cloud.translation.v3beta1.json b/owl-bot-staging/v3beta1/samples/generated_samples/snippet_metadata_google.cloud.translation.v3beta1.json deleted file mode 100644 index 42d10a50..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/snippet_metadata_google.cloud.translation.v3beta1.json +++ /dev/null @@ -1,1681 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.translation.v3beta1", - "version": "v3beta1" - } - ], - "language": "PYTHON", - "name": "google-cloud-translate", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.batch_translate_document", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "target_language_codes", - "type": "MutableSequence[str]" - }, - { - "name": "input_configs", - "type": "MutableSequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]" - }, - { - "name": "output_config", - "type": "google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "batch_translate_document" - }, - "description": "Sample for BatchTranslateDocument", - "file": "translate_v3beta1_generated_translation_service_batch_translate_document_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_BatchTranslateDocument_async", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_batch_translate_document_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.batch_translate_document", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.BatchTranslateDocumentRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "source_language_code", - "type": "str" - }, - { - "name": "target_language_codes", - "type": "MutableSequence[str]" - }, - { - "name": "input_configs", - "type": "MutableSequence[google.cloud.translate_v3beta1.types.BatchDocumentInputConfig]" - }, - { - "name": "output_config", - "type": "google.cloud.translate_v3beta1.types.BatchDocumentOutputConfig" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "batch_translate_document" - }, - "description": "Sample for BatchTranslateDocument", - "file": "translate_v3beta1_generated_translation_service_batch_translate_document_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_BatchTranslateDocument_sync", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_batch_translate_document_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.batch_translate_text", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateText", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.BatchTranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "batch_translate_text" - }, - "description": "Sample for BatchTranslateText", - "file": "translate_v3beta1_generated_translation_service_batch_translate_text_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_BatchTranslateText_async", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_batch_translate_text_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.batch_translate_text", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.BatchTranslateText", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "BatchTranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.BatchTranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "batch_translate_text" - }, - "description": "Sample for BatchTranslateText", - "file": "translate_v3beta1_generated_translation_service_batch_translate_text_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_BatchTranslateText_sync", - "segments": [ - { - "end": 65, - "start": 27, - "type": "FULL" - }, - { - "end": 65, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 55, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 62, - "start": 56, - "type": "REQUEST_EXECUTION" - }, - { - "end": 66, - "start": 63, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_batch_translate_text_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.create_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.CreateGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "CreateGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.CreateGlossaryRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "glossary", - "type": "google.cloud.translate_v3beta1.types.Glossary" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "create_glossary" - }, - "description": "Sample for CreateGlossary", - "file": "translate_v3beta1_generated_translation_service_create_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_CreateGlossary_async", - "segments": [ - { - "end": 59, - "start": 27, - "type": "FULL" - }, - { - "end": 59, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 56, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 60, - "start": 57, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_create_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.create_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.CreateGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "CreateGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.CreateGlossaryRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "glossary", - "type": "google.cloud.translate_v3beta1.types.Glossary" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "create_glossary" - }, - "description": "Sample for CreateGlossary", - "file": "translate_v3beta1_generated_translation_service_create_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_CreateGlossary_sync", - "segments": [ - { - "end": 59, - "start": 27, - "type": "FULL" - }, - { - "end": 59, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 49, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 56, - "start": 50, - "type": "REQUEST_EXECUTION" - }, - { - "end": 60, - "start": 57, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_create_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.delete_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.DeleteGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DeleteGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.DeleteGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation_async.AsyncOperation", - "shortName": "delete_glossary" - }, - "description": "Sample for DeleteGlossary", - "file": "translate_v3beta1_generated_translation_service_delete_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_DeleteGlossary_async", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_delete_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.delete_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.DeleteGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DeleteGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.DeleteGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.api_core.operation.Operation", - "shortName": "delete_glossary" - }, - "description": "Sample for DeleteGlossary", - "file": "translate_v3beta1_generated_translation_service_delete_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_DeleteGlossary_sync", - "segments": [ - { - "end": 55, - "start": 27, - "type": "FULL" - }, - { - "end": 55, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 52, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 56, - "start": 53, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_delete_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.detect_language", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.DetectLanguage", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DetectLanguage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.DetectLanguageRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.DetectLanguageResponse", - "shortName": "detect_language" - }, - "description": "Sample for DetectLanguage", - "file": "translate_v3beta1_generated_translation_service_detect_language_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_DetectLanguage_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_detect_language_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.detect_language", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.DetectLanguage", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "DetectLanguage" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.DetectLanguageRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "mime_type", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.DetectLanguageResponse", - "shortName": "detect_language" - }, - "description": "Sample for DetectLanguage", - "file": "translate_v3beta1_generated_translation_service_detect_language_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_DetectLanguage_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_detect_language_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.get_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.GetGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.Glossary", - "shortName": "get_glossary" - }, - "description": "Sample for GetGlossary", - "file": "translate_v3beta1_generated_translation_service_get_glossary_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_GetGlossary_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_get_glossary_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.get_glossary", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetGlossary", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetGlossary" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.GetGlossaryRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.Glossary", - "shortName": "get_glossary" - }, - "description": "Sample for GetGlossary", - "file": "translate_v3beta1_generated_translation_service_get_glossary_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_GetGlossary_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_get_glossary_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.get_supported_languages", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetSupportedLanguages", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetSupportedLanguages" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "display_language_code", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.SupportedLanguages", - "shortName": "get_supported_languages" - }, - "description": "Sample for GetSupportedLanguages", - "file": "translate_v3beta1_generated_translation_service_get_supported_languages_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_GetSupportedLanguages_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_get_supported_languages_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.get_supported_languages", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.GetSupportedLanguages", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "GetSupportedLanguages" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.GetSupportedLanguagesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "display_language_code", - "type": "str" - }, - { - "name": "model", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.SupportedLanguages", - "shortName": "get_supported_languages" - }, - "description": "Sample for GetSupportedLanguages", - "file": "translate_v3beta1_generated_translation_service_get_supported_languages_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_GetSupportedLanguages_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_get_supported_languages_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.list_glossaries", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.ListGlossaries", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "ListGlossaries" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.ListGlossariesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "filter", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.services.translation_service.pagers.ListGlossariesAsyncPager", - "shortName": "list_glossaries" - }, - "description": "Sample for ListGlossaries", - "file": "translate_v3beta1_generated_translation_service_list_glossaries_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_ListGlossaries_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_list_glossaries_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.list_glossaries", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.ListGlossaries", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "ListGlossaries" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.ListGlossariesRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "filter", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.services.translation_service.pagers.ListGlossariesPager", - "shortName": "list_glossaries" - }, - "description": "Sample for ListGlossaries", - "file": "translate_v3beta1_generated_translation_service_list_glossaries_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_ListGlossaries_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_list_glossaries_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.translate_document", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.TranslateDocumentRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.TranslateDocumentResponse", - "shortName": "translate_document" - }, - "description": "Sample for TranslateDocument", - "file": "translate_v3beta1_generated_translation_service_translate_document_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_TranslateDocument_async", - "segments": [ - { - "end": 56, - "start": 27, - "type": "FULL" - }, - { - "end": 56, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 50, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 53, - "start": 51, - "type": "REQUEST_EXECUTION" - }, - { - "end": 57, - "start": 54, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_translate_document_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.translate_document", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateDocument", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateDocument" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.TranslateDocumentRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.TranslateDocumentResponse", - "shortName": "translate_document" - }, - "description": "Sample for TranslateDocument", - "file": "translate_v3beta1_generated_translation_service_translate_document_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_TranslateDocument_sync", - "segments": [ - { - "end": 56, - "start": 27, - "type": "FULL" - }, - { - "end": 56, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 50, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 53, - "start": 51, - "type": "REQUEST_EXECUTION" - }, - { - "end": 57, - "start": 54, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_translate_document_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient", - "shortName": "TranslationServiceAsyncClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceAsyncClient.translate_text", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateText", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.TranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.TranslateTextResponse", - "shortName": "translate_text" - }, - "description": "Sample for TranslateText", - "file": "translate_v3beta1_generated_translation_service_translate_text_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_TranslateText_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_translate_text_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient", - "shortName": "TranslationServiceClient" - }, - "fullName": "google.cloud.translate_v3beta1.TranslationServiceClient.translate_text", - "method": { - "fullName": "google.cloud.translation.v3beta1.TranslationService.TranslateText", - "service": { - "fullName": "google.cloud.translation.v3beta1.TranslationService", - "shortName": "TranslationService" - }, - "shortName": "TranslateText" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.translate_v3beta1.types.TranslateTextRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.translate_v3beta1.types.TranslateTextResponse", - "shortName": "translate_text" - }, - "description": "Sample for TranslateText", - "file": "translate_v3beta1_generated_translation_service_translate_text_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "translate_v3beta1_generated_TranslationService_TranslateText_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "translate_v3beta1_generated_translation_service_translate_text_sync.py" - } - ] -} diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_async.py deleted file mode 100644 index 289168f5..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_async.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateDocument -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_BatchTranslateDocument_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.cloud import translate_v3beta1 - - -async def sample_batch_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_BatchTranslateDocument_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_sync.py deleted file mode 100644 index 75ff090f..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_document_sync.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateDocument -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_BatchTranslateDocument_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.cloud import translate_v3beta1 - - -def sample_batch_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.BatchDocumentInputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.BatchDocumentOutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateDocumentRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_document(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_BatchTranslateDocument_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_async.py deleted file mode 100644 index 16426a2e..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_async.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateText -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_BatchTranslateText_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.cloud import translate_v3beta1 - - -async def sample_batch_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_BatchTranslateText_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_sync.py deleted file mode 100644 index 61042f20..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_batch_translate_text_sync.py +++ /dev/null @@ -1,66 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 BatchTranslateText -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_BatchTranslateText_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.cloud import translate_v3beta1 - - -def sample_batch_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - input_configs = translate_v3beta1.InputConfig() - input_configs.gcs_source.input_uri = "input_uri_value" - - output_config = translate_v3beta1.OutputConfig() - output_config.gcs_destination.output_uri_prefix = "output_uri_prefix_value" - - request = translate_v3beta1.BatchTranslateTextRequest( - parent="parent_value", - source_language_code="source_language_code_value", - target_language_codes=['target_language_codes_value1', 'target_language_codes_value2'], - input_configs=input_configs, - output_config=output_config, - ) - - # Make the request - operation = client.batch_translate_text(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_BatchTranslateText_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_async.py deleted file mode 100644 index 423484bb..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_async.py +++ /dev/null @@ -1,60 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 CreateGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_CreateGlossary_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.cloud import translate_v3beta1 - - -async def sample_create_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - glossary = translate_v3beta1.Glossary() - glossary.name = "name_value" - - request = translate_v3beta1.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_CreateGlossary_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_sync.py deleted file mode 100644 index feab863e..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_create_glossary_sync.py +++ /dev/null @@ -1,60 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 CreateGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_CreateGlossary_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.cloud import translate_v3beta1 - - -def sample_create_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - glossary = translate_v3beta1.Glossary() - glossary.name = "name_value" - - request = translate_v3beta1.CreateGlossaryRequest( - parent="parent_value", - glossary=glossary, - ) - - # Make the request - operation = client.create_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_CreateGlossary_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_async.py deleted file mode 100644 index c8ac233c..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_async.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DeleteGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_DeleteGlossary_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.cloud import translate_v3beta1 - - -async def sample_delete_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = (await operation).result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_DeleteGlossary_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_sync.py deleted file mode 100644 index 777af6b6..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_delete_glossary_sync.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DeleteGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_DeleteGlossary_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.cloud import translate_v3beta1 - - -def sample_delete_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.DeleteGlossaryRequest( - name="name_value", - ) - - # Make the request - operation = client.delete_glossary(request=request) - - print("Waiting for operation to complete...") - - response = operation.result() - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_DeleteGlossary_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_async.py deleted file mode 100644 index 037d10b2..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DetectLanguage -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_DetectLanguage_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.cloud import translate_v3beta1 - - -async def sample_detect_language(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = await client.detect_language(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_DetectLanguage_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_sync.py deleted file mode 100644 index 729b99c6..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_detect_language_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 DetectLanguage -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_DetectLanguage_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.cloud import translate_v3beta1 - - -def sample_detect_language(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.DetectLanguageRequest( - content="content_value", - parent="parent_value", - ) - - # Make the request - response = client.detect_language(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_DetectLanguage_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_async.py deleted file mode 100644 index 3464078d..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_GetGlossary_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.cloud import translate_v3beta1 - - -async def sample_get_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = await client.get_glossary(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_GetGlossary_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_sync.py deleted file mode 100644 index 9e91f767..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_glossary_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetGlossary -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_GetGlossary_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.cloud import translate_v3beta1 - - -def sample_get_glossary(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetGlossaryRequest( - name="name_value", - ) - - # Make the request - response = client.get_glossary(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_GetGlossary_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_async.py deleted file mode 100644 index b21d728c..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetSupportedLanguages -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_GetSupportedLanguages_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.cloud import translate_v3beta1 - - -async def sample_get_supported_languages(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = await client.get_supported_languages(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_GetSupportedLanguages_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_sync.py deleted file mode 100644 index 81e89031..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_get_supported_languages_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 GetSupportedLanguages -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_GetSupportedLanguages_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.cloud import translate_v3beta1 - - -def sample_get_supported_languages(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.GetSupportedLanguagesRequest( - parent="parent_value", - ) - - # Make the request - response = client.get_supported_languages(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_GetSupportedLanguages_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_async.py deleted file mode 100644 index d5bc4a95..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 ListGlossaries -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_ListGlossaries_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.cloud import translate_v3beta1 - - -async def sample_list_glossaries(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - async for response in page_result: - print(response) - -# [END translate_v3beta1_generated_TranslationService_ListGlossaries_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_sync.py deleted file mode 100644 index b1ed7a8f..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_list_glossaries_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 ListGlossaries -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_ListGlossaries_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.cloud import translate_v3beta1 - - -def sample_list_glossaries(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.ListGlossariesRequest( - parent="parent_value", - ) - - # Make the request - page_result = client.list_glossaries(request=request) - - # Handle the response - for response in page_result: - print(response) - -# [END translate_v3beta1_generated_TranslationService_ListGlossaries_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_async.py deleted file mode 100644 index 3c4c5c13..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_async.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateDocument -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_TranslateDocument_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.cloud import translate_v3beta1 - - -async def sample_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - document_input_config = translate_v3beta1.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3beta1.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = await client.translate_document(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_TranslateDocument_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_sync.py deleted file mode 100644 index 0d975903..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_document_sync.py +++ /dev/null @@ -1,57 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateDocument -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_TranslateDocument_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.cloud import translate_v3beta1 - - -def sample_translate_document(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - document_input_config = translate_v3beta1.DocumentInputConfig() - document_input_config.content = b'content_blob' - - request = translate_v3beta1.TranslateDocumentRequest( - parent="parent_value", - target_language_code="target_language_code_value", - document_input_config=document_input_config, - ) - - # Make the request - response = client.translate_document(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_TranslateDocument_sync] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_async.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_async.py deleted file mode 100644 index 405a911c..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateText -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_TranslateText_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.cloud import translate_v3beta1 - - -async def sample_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceAsyncClient() - - # Initialize request argument(s) - request = translate_v3beta1.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = await client.translate_text(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_TranslateText_async] diff --git a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_sync.py b/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_sync.py deleted file mode 100644 index 8e5bf3bd..00000000 --- a/owl-bot-staging/v3beta1/samples/generated_samples/translate_v3beta1_generated_translation_service_translate_text_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 TranslateText -# 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-cloud-translate - - -# [START translate_v3beta1_generated_TranslationService_TranslateText_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.cloud import translate_v3beta1 - - -def sample_translate_text(): - # Create a client - client = translate_v3beta1.TranslationServiceClient() - - # Initialize request argument(s) - request = translate_v3beta1.TranslateTextRequest( - contents=['contents_value1', 'contents_value2'], - target_language_code="target_language_code_value", - parent="parent_value", - ) - - # Make the request - response = client.translate_text(request=request) - - # Handle the response - print(response) - -# [END translate_v3beta1_generated_TranslationService_TranslateText_sync] diff --git a/owl-bot-staging/v3beta1/scripts/fixup_translate_v3beta1_keywords.py b/owl-bot-staging/v3beta1/scripts/fixup_translate_v3beta1_keywords.py deleted file mode 100644 index ef488ce1..00000000 --- a/owl-bot-staging/v3beta1/scripts/fixup_translate_v3beta1_keywords.py +++ /dev/null @@ -1,185 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2023 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 translateCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'batch_translate_document': ('parent', 'source_language_code', 'target_language_codes', 'input_configs', 'output_config', 'models', 'glossaries', 'format_conversions', 'customized_attribution', 'enable_shadow_removal_native_pdf', 'enable_rotation_correction', ), - 'batch_translate_text': ('parent', 'source_language_code', 'target_language_codes', 'input_configs', 'output_config', 'models', 'glossaries', 'labels', ), - 'create_glossary': ('parent', 'glossary', ), - 'delete_glossary': ('name', ), - 'detect_language': ('parent', 'model', 'content', 'mime_type', 'labels', ), - 'get_glossary': ('name', ), - 'get_supported_languages': ('parent', 'display_language_code', 'model', ), - 'list_glossaries': ('parent', 'page_size', 'page_token', 'filter', ), - 'translate_document': ('parent', 'target_language_code', 'document_input_config', 'source_language_code', 'document_output_config', 'model', 'glossary_config', 'labels', 'customized_attribution', 'is_translate_native_pdf_only', 'enable_shadow_removal_native_pdf', 'enable_rotation_correction', ), - 'translate_text': ('contents', 'target_language_code', 'parent', 'mime_type', 'source_language_code', 'model', 'glossary_config', 'labels', ), - } - - 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=translateCallTransformer(), -): - """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 translate 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/v3beta1/setup.py b/owl-bot-staging/v3beta1/setup.py deleted file mode 100644 index b5127264..00000000 --- a/owl-bot-staging/v3beta1/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-translate' - - -description = "Google Cloud Translate API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/translate/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -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.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-translate" - -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.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -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", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.10.txt b/owl-bot-staging/v3beta1/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.11.txt b/owl-bot-staging/v3beta1/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.12.txt b/owl-bot-staging/v3beta1/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.7.txt b/owl-bot-staging/v3beta1/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adfe..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +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.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.8.txt b/owl-bot-staging/v3beta1/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3beta1/testing/constraints-3.9.txt b/owl-bot-staging/v3beta1/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9aed..00000000 --- a/owl-bot-staging/v3beta1/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +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 diff --git a/owl-bot-staging/v3beta1/tests/__init__.py b/owl-bot-staging/v3beta1/tests/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3beta1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/tests/unit/__init__.py b/owl-bot-staging/v3beta1/tests/unit/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3beta1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v3beta1/tests/unit/gapic/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3beta1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/tests/unit/gapic/translate_v3beta1/__init__.py b/owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/__init__.py deleted file mode 100644 index 1b4db446..00000000 --- a/owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 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/v3beta1/tests/unit/gapic/translate_v3beta1/test_translation_service.py b/owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/test_translation_service.py deleted file mode 100644 index de14d5c6..00000000 --- a/owl-bot-staging/v3beta1/tests/unit/gapic/translate_v3beta1/test_translation_service.py +++ /dev/null @@ -1,6008 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 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 -from google.protobuf import json_format -import json -import math -import pytest -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 - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import future -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 operation -from google.api_core import operation_async # type: ignore -from google.api_core import operations_v1 -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.translate_v3beta1.services.translation_service import TranslationServiceAsyncClient -from google.cloud.translate_v3beta1.services.translation_service import TranslationServiceClient -from google.cloud.translate_v3beta1.services.translation_service import pagers -from google.cloud.translate_v3beta1.services.translation_service import transports -from google.cloud.translate_v3beta1.types import translation_service -from google.longrunning import operations_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import timestamp_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# 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 - - -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 TranslationServiceClient._get_default_mtls_endpoint(None) is None - assert TranslationServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert TranslationServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class,transport_name", [ - (TranslationServiceClient, "grpc"), - (TranslationServiceAsyncClient, "grpc_asyncio"), - (TranslationServiceClient, "rest"), -]) -def test_translation_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 == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://translate.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.TranslationServiceGrpcTransport, "grpc"), - (transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.TranslationServiceRestTransport, "rest"), -]) -def test_translation_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", [ - (TranslationServiceClient, "grpc"), - (TranslationServiceAsyncClient, "grpc_asyncio"), - (TranslationServiceClient, "rest"), -]) -def test_translation_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 == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://translate.googleapis.com' - ) - - -def test_translation_service_client_get_transport_class(): - transport = TranslationServiceClient.get_transport_class() - available_transports = [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceRestTransport, - ] - assert transport in available_transports - - transport = TranslationServiceClient.get_transport_class("grpc") - assert transport == transports.TranslationServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest"), -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -def test_translation_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(TranslationServiceClient, '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(TranslationServiceClient, '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, - 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): - client = client_class(transport=transport_name) - - # 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): - client = client_class(transport=transport_name) - - # 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, - 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, - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", "true"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", "false"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", "true"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_translation_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 - 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 - 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, - 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", [ - TranslationServiceClient, TranslationServiceAsyncClient -]) -@mock.patch.object(TranslationServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceClient)) -@mock.patch.object(TranslationServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(TranslationServiceAsyncClient)) -def test_translation_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 - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc"), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest"), -]) -def test_translation_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, - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", grpc_helpers), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (TranslationServiceClient, transports.TranslationServiceRestTransport, "rest", None), -]) -def test_translation_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, - 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_translation_service_client_client_options_from_dict(): - with mock.patch('google.cloud.translate_v3beta1.services.translation_service.transports.TranslationServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = TranslationServiceClient( - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport, "grpc", grpc_helpers), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_translation_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, - 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( - "translate.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - scopes=None, - default_host="translate.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateTextRequest, - dict, -]) -def test_translate_text(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateTextResponse( - ) - response = client.translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -def test_translate_text_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - client.translate_text() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - -@pytest.mark.asyncio -async def test_translate_text_async(transport: str = 'grpc_asyncio', request_type=translation_service.TranslateTextRequest): - client = TranslationServiceAsyncClient( - 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.translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateTextResponse( - )) - response = await client.translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -@pytest.mark.asyncio -async def test_translate_text_async_from_dict(): - await test_translate_text_async(request_type=dict) - - -def test_translate_text_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.TranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - call.return_value = translation_service.TranslateTextResponse() - client.translate_text(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_translate_text_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.TranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_text), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateTextResponse()) - await client.translate_text(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'] - - -@pytest.mark.parametrize("request_type", [ - translation_service.DetectLanguageRequest, - dict, -]) -def test_detect_language(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse( - ) - response = client.detect_language(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -def test_detect_language_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - client.detect_language() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - -@pytest.mark.asyncio -async def test_detect_language_async(transport: str = 'grpc_asyncio', request_type=translation_service.DetectLanguageRequest): - client = TranslationServiceAsyncClient( - 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.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse( - )) - response = await client.detect_language(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DetectLanguageRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -@pytest.mark.asyncio -async def test_detect_language_async_from_dict(): - await test_detect_language_async(request_type=dict) - - -def test_detect_language_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.DetectLanguageRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - call.return_value = translation_service.DetectLanguageResponse() - client.detect_language(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_detect_language_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.DetectLanguageRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse()) - await client.detect_language(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_detect_language_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.detect_language( - parent='parent_value', - model='model_value', - mime_type='mime_type_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - - -def test_detect_language_flattened_error(): - client = TranslationServiceClient( - 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.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - ) - -@pytest.mark.asyncio -async def test_detect_language_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.detect_language), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.DetectLanguageResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.DetectLanguageResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.detect_language( - parent='parent_value', - model='model_value', - mime_type='mime_type_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].model - mock_val = 'model_value' - assert arg == mock_val - arg = args[0].mime_type - mock_val = 'mime_type_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_detect_language_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetSupportedLanguagesRequest, - dict, -]) -def test_get_supported_languages(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages( - ) - response = client.get_supported_languages(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -def test_get_supported_languages_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - client.get_supported_languages() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - -@pytest.mark.asyncio -async def test_get_supported_languages_async(transport: str = 'grpc_asyncio', request_type=translation_service.GetSupportedLanguagesRequest): - client = TranslationServiceAsyncClient( - 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.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages( - )) - response = await client.get_supported_languages(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetSupportedLanguagesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -@pytest.mark.asyncio -async def test_get_supported_languages_async_from_dict(): - await test_get_supported_languages_async(request_type=dict) - - -def test_get_supported_languages_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.GetSupportedLanguagesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - call.return_value = translation_service.SupportedLanguages() - client.get_supported_languages(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_get_supported_languages_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.GetSupportedLanguagesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages()) - await client.get_supported_languages(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_get_supported_languages_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_supported_languages( - parent='parent_value', - display_language_code='display_language_code_value', - model='model_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].display_language_code - mock_val = 'display_language_code_value' - assert arg == mock_val - arg = args[0].model - mock_val = 'model_value' - assert arg == mock_val - - -def test_get_supported_languages_flattened_error(): - client = TranslationServiceClient( - 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.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - display_language_code='display_language_code_value', - model='model_value', - ) - -@pytest.mark.asyncio -async def test_get_supported_languages_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_supported_languages), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.SupportedLanguages() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.SupportedLanguages()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_supported_languages( - parent='parent_value', - display_language_code='display_language_code_value', - model='model_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].display_language_code - mock_val = 'display_language_code_value' - assert arg == mock_val - arg = args[0].model - mock_val = 'model_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_supported_languages_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - display_language_code='display_language_code_value', - model='model_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateDocumentRequest, - dict, -]) -def test_translate_document(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.TranslateDocumentResponse( - model='model_value', - ) - response = client.translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -def test_translate_document_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - client.translate_document() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - -@pytest.mark.asyncio -async def test_translate_document_async(transport: str = 'grpc_asyncio', request_type=translation_service.TranslateDocumentRequest): - client = TranslationServiceAsyncClient( - 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.translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateDocumentResponse( - model='model_value', - )) - response = await client.translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.TranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -@pytest.mark.asyncio -async def test_translate_document_async_from_dict(): - await test_translate_document_async(request_type=dict) - - -def test_translate_document_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.TranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - call.return_value = translation_service.TranslateDocumentResponse() - client.translate_document(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_translate_document_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.TranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.translate_document), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.TranslateDocumentResponse()) - await client.translate_document(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'] - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateTextRequest, - dict, -]) -def test_batch_translate_text(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.batch_translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.batch_translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_batch_translate_text_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - client.batch_translate_text() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - -@pytest.mark.asyncio -async def test_batch_translate_text_async(transport: str = 'grpc_asyncio', request_type=translation_service.BatchTranslateTextRequest): - client = TranslationServiceAsyncClient( - 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.batch_translate_text), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.batch_translate_text(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateTextRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_batch_translate_text_async_from_dict(): - await test_batch_translate_text_async(request_type=dict) - - -def test_batch_translate_text_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.BatchTranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.batch_translate_text(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_batch_translate_text_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.BatchTranslateTextRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_text), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.batch_translate_text(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'] - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateDocumentRequest, - dict, -]) -def test_batch_translate_document(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.batch_translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_batch_translate_document_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - client.batch_translate_document() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - -@pytest.mark.asyncio -async def test_batch_translate_document_async(transport: str = 'grpc_asyncio', request_type=translation_service.BatchTranslateDocumentRequest): - client = TranslationServiceAsyncClient( - 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.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.batch_translate_document(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.BatchTranslateDocumentRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_batch_translate_document_async_from_dict(): - await test_batch_translate_document_async(request_type=dict) - - -def test_batch_translate_document_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.BatchTranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.batch_translate_document(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_batch_translate_document_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.BatchTranslateDocumentRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.batch_translate_document(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_batch_translate_document_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.batch_translate_document( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_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].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - arg = args[0].target_language_codes - mock_val = ['target_language_codes_value'] - assert arg == mock_val - arg = args[0].input_configs - mock_val = [translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))] - assert arg == mock_val - arg = args[0].output_config - mock_val = translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')) - assert arg == mock_val - - -def test_batch_translate_document_flattened_error(): - client = TranslationServiceClient( - 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.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - -@pytest.mark.asyncio -async def test_batch_translate_document_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.batch_translate_document), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.batch_translate_document( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_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].source_language_code - mock_val = 'source_language_code_value' - assert arg == mock_val - arg = args[0].target_language_codes - mock_val = ['target_language_codes_value'] - assert arg == mock_val - arg = args[0].input_configs - mock_val = [translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))] - assert arg == mock_val - arg = args[0].output_config - mock_val = translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')) - assert arg == mock_val - -@pytest.mark.asyncio -async def test_batch_translate_document_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.CreateGlossaryRequest, - dict, -]) -def test_create_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.create_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_create_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - client.create_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - -@pytest.mark.asyncio -async def test_create_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.CreateGlossaryRequest): - client = TranslationServiceAsyncClient( - 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_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.create_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.CreateGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_create_glossary_async_from_dict(): - await test_create_glossary_async(request_type=dict) - - -def test_create_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.CreateGlossaryRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.create_glossary(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_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.CreateGlossaryRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.create_glossary(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_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_glossary( - parent='parent_value', - glossary=translation_service.Glossary(name='name_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].glossary - mock_val = translation_service.Glossary(name='name_value') - assert arg == mock_val - - -def test_create_glossary_flattened_error(): - client = TranslationServiceClient( - 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_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - -@pytest.mark.asyncio -async def test_create_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_glossary( - parent='parent_value', - glossary=translation_service.Glossary(name='name_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].glossary - mock_val = translation_service.Glossary(name='name_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.create_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.ListGlossariesRequest, - dict, -]) -def test_list_glossaries(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - ) - response = client.list_glossaries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_glossaries_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - client.list_glossaries() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - -@pytest.mark.asyncio -async def test_list_glossaries_async(transport: str = 'grpc_asyncio', request_type=translation_service.ListGlossariesRequest): - client = TranslationServiceAsyncClient( - 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.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_glossaries(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.ListGlossariesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_glossaries_async_from_dict(): - await test_list_glossaries_async(request_type=dict) - - -def test_list_glossaries_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.ListGlossariesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - call.return_value = translation_service.ListGlossariesResponse() - client.list_glossaries(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_list_glossaries_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.ListGlossariesRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse()) - await client.list_glossaries(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_list_glossaries_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_glossaries( - parent='parent_value', - filter='filter_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].filter - mock_val = 'filter_value' - assert arg == mock_val - - -def test_list_glossaries_flattened_error(): - client = TranslationServiceClient( - 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.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - filter='filter_value', - ) - -@pytest.mark.asyncio -async def test_list_glossaries_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.ListGlossariesResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.ListGlossariesResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_glossaries( - parent='parent_value', - filter='filter_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].filter - mock_val = 'filter_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_list_glossaries_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - filter='filter_value', - ) - - -def test_list_glossaries_pager(transport_name: str = "grpc"): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_glossaries(request={}) - - assert pager._metadata == metadata - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in results) -def test_list_glossaries_pages(transport_name: str = "grpc"): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials, - transport=transport_name, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - pages = list(client.list_glossaries(request={}).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.asyncio -async def test_list_glossaries_async_pager(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_glossaries(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: # pragma: no branch - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in responses) - - -@pytest.mark.asyncio -async def test_list_glossaries_async_pages(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_glossaries), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - RuntimeError, - ) - pages = [] - # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` - # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 - async for page_ in ( # pragma: no branch - await client.list_glossaries(request={}) - ).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -@pytest.mark.parametrize("request_type", [ - translation_service.GetGlossaryRequest, - dict, -]) -def test_get_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary( - name='name_value', - entry_count=1210, - ) - response = client.get_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - - -def test_get_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - client.get_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - -@pytest.mark.asyncio -async def test_get_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.GetGlossaryRequest): - client = TranslationServiceAsyncClient( - 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.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary( - name='name_value', - entry_count=1210, - )) - response = await client.get_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.GetGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - - -@pytest.mark.asyncio -async def test_get_glossary_async_from_dict(): - await test_get_glossary_async(request_type=dict) - - -def test_get_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.GetGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - call.return_value = translation_service.Glossary() - client.get_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.GetGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary()) - await client.get_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_get_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_get_glossary_flattened_error(): - client = TranslationServiceClient( - 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.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = translation_service.Glossary() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(translation_service.Glossary()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DeleteGlossaryRequest, - dict, -]) -def test_delete_glossary(request_type, transport: str = 'grpc'): - client = TranslationServiceClient( - 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.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.delete_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_delete_glossary_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - client.delete_glossary() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - -@pytest.mark.asyncio -async def test_delete_glossary_async(transport: str = 'grpc_asyncio', request_type=translation_service.DeleteGlossaryRequest): - client = TranslationServiceAsyncClient( - 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.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - response = await client.delete_glossary(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == translation_service.DeleteGlossaryRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_delete_glossary_async_from_dict(): - await test_delete_glossary_async(request_type=dict) - - -def test_delete_glossary_field_headers(): - client = TranslationServiceClient( - 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 = translation_service.DeleteGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - call.return_value = operations_pb2.Operation(name='operations/op') - client.delete_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_glossary_field_headers_async(): - client = TranslationServiceAsyncClient( - 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 = translation_service.DeleteGlossaryRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(operations_pb2.Operation(name='operations/op')) - await client.delete_glossary(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_delete_glossary_flattened(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_delete_glossary_flattened_error(): - client = TranslationServiceClient( - 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.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_glossary_flattened_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_glossary), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/op') - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( - operations_pb2.Operation(name='operations/spam') - ) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_glossary( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_delete_glossary_flattened_error_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateTextRequest, - dict, -]) -def test_translate_text_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.TranslateTextResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.TranslateTextResponse.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 - response = client.translate_text(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateTextResponse) - - -def test_translate_text_rest_required_fields(request_type=translation_service.TranslateTextRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["contents"] = "" - request_init["target_language_code"] = "" - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_text._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["contents"] = 'contents_value' - jsonified_request["targetLanguageCode"] = 'target_language_code_value' - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_text._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "contents" in jsonified_request - assert jsonified_request["contents"] == 'contents_value' - assert "targetLanguageCode" in jsonified_request - assert jsonified_request["targetLanguageCode"] == 'target_language_code_value' - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.TranslateTextResponse() - # 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 = translation_service.TranslateTextResponse.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 - - response = client.translate_text(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_translate_text_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.translate_text._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("contents", "targetLanguageCode", "parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_translate_text_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_translate_text") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_translate_text") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.TranslateTextRequest.pb(translation_service.TranslateTextRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.TranslateTextResponse.to_json(translation_service.TranslateTextResponse()) - - request = translation_service.TranslateTextRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.TranslateTextResponse() - - client.translate_text(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_translate_text_rest_bad_request(transport: str = 'rest', request_type=translation_service.TranslateTextRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.translate_text(request) - - -def test_translate_text_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DetectLanguageRequest, - dict, -]) -def test_detect_language_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.DetectLanguageResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.DetectLanguageResponse.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 - response = client.detect_language(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.DetectLanguageResponse) - - -def test_detect_language_rest_required_fields(request_type=translation_service.DetectLanguageRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).detect_language._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()).detect_language._get_unset_required_fields(jsonified_request) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.DetectLanguageResponse() - # 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 = translation_service.DetectLanguageResponse.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 - - response = client.detect_language(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_detect_language_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.detect_language._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_detect_language_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_detect_language") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_detect_language") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.DetectLanguageRequest.pb(translation_service.DetectLanguageRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.DetectLanguageResponse.to_json(translation_service.DetectLanguageResponse()) - - request = translation_service.DetectLanguageRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.DetectLanguageResponse() - - client.detect_language(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_detect_language_rest_bad_request(transport: str = 'rest', request_type=translation_service.DetectLanguageRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.detect_language(request) - - -def test_detect_language_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.DetectLanguageResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - model='model_value', - mime_type='mime_type_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 = translation_service.DetectLanguageResponse.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 - - client.detect_language(**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/v3beta1/{parent=projects/*/locations/*}:detectLanguage" % client.transport._host, args[1]) - - -def test_detect_language_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.detect_language( - translation_service.DetectLanguageRequest(), - parent='parent_value', - model='model_value', - mime_type='mime_type_value', - ) - - -def test_detect_language_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetSupportedLanguagesRequest, - dict, -]) -def test_get_supported_languages_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.SupportedLanguages( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.SupportedLanguages.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 - response = client.get_supported_languages(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.SupportedLanguages) - - -def test_get_supported_languages_rest_required_fields(request_type=translation_service.GetSupportedLanguagesRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_supported_languages._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()).get_supported_languages._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("display_language_code", "model", )) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.SupportedLanguages() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.SupportedLanguages.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 - - response = client.get_supported_languages(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_supported_languages_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_supported_languages._get_unset_required_fields({}) - assert set(unset_fields) == (set(("displayLanguageCode", "model", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_supported_languages_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_get_supported_languages") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_get_supported_languages") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.GetSupportedLanguagesRequest.pb(translation_service.GetSupportedLanguagesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.SupportedLanguages.to_json(translation_service.SupportedLanguages()) - - request = translation_service.GetSupportedLanguagesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.SupportedLanguages() - - client.get_supported_languages(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_supported_languages_rest_bad_request(transport: str = 'rest', request_type=translation_service.GetSupportedLanguagesRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_supported_languages(request) - - -def test_get_supported_languages_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.SupportedLanguages() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - display_language_code='display_language_code_value', - model='model_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 = translation_service.SupportedLanguages.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 - - client.get_supported_languages(**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/v3beta1/{parent=projects/*/locations/*}/supportedLanguages" % client.transport._host, args[1]) - - -def test_get_supported_languages_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.get_supported_languages( - translation_service.GetSupportedLanguagesRequest(), - parent='parent_value', - display_language_code='display_language_code_value', - model='model_value', - ) - - -def test_get_supported_languages_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.TranslateDocumentRequest, - dict, -]) -def test_translate_document_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.TranslateDocumentResponse( - model='model_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.TranslateDocumentResponse.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 - response = client.translate_document(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.TranslateDocumentResponse) - assert response.model == 'model_value' - - -def test_translate_document_rest_required_fields(request_type=translation_service.TranslateDocumentRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["target_language_code"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_document._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["targetLanguageCode"] = 'target_language_code_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).translate_document._get_unset_required_fields(jsonified_request) - 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 "targetLanguageCode" in jsonified_request - assert jsonified_request["targetLanguageCode"] == 'target_language_code_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.TranslateDocumentResponse() - # 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 = translation_service.TranslateDocumentResponse.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 - - response = client.translate_document(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_translate_document_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.translate_document._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "targetLanguageCode", "documentInputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_translate_document_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_translate_document") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_translate_document") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.TranslateDocumentRequest.pb(translation_service.TranslateDocumentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.TranslateDocumentResponse.to_json(translation_service.TranslateDocumentResponse()) - - request = translation_service.TranslateDocumentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.TranslateDocumentResponse() - - client.translate_document(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_translate_document_rest_bad_request(transport: str = 'rest', request_type=translation_service.TranslateDocumentRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.translate_document(request) - - -def test_translate_document_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateTextRequest, - dict, -]) -def test_batch_translate_text_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.batch_translate_text(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_batch_translate_text_rest_required_fields(request_type=translation_service.BatchTranslateTextRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["source_language_code"] = "" - request_init["target_language_codes"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_text._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["sourceLanguageCode"] = 'source_language_code_value' - jsonified_request["targetLanguageCodes"] = 'target_language_codes_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_text._get_unset_required_fields(jsonified_request) - 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 "sourceLanguageCode" in jsonified_request - assert jsonified_request["sourceLanguageCode"] == 'source_language_code_value' - assert "targetLanguageCodes" in jsonified_request - assert jsonified_request["targetLanguageCodes"] == 'target_language_codes_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.batch_translate_text(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_batch_translate_text_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.batch_translate_text._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "sourceLanguageCode", "targetLanguageCodes", "inputConfigs", "outputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_batch_translate_text_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_batch_translate_text") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_batch_translate_text") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.BatchTranslateTextRequest.pb(translation_service.BatchTranslateTextRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.BatchTranslateTextRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.batch_translate_text(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_batch_translate_text_rest_bad_request(transport: str = 'rest', request_type=translation_service.BatchTranslateTextRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.batch_translate_text(request) - - -def test_batch_translate_text_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.BatchTranslateDocumentRequest, - dict, -]) -def test_batch_translate_document_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.batch_translate_document(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_batch_translate_document_rest_required_fields(request_type=translation_service.BatchTranslateDocumentRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request_init["source_language_code"] = "" - request_init["target_language_codes"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_document._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["sourceLanguageCode"] = 'source_language_code_value' - jsonified_request["targetLanguageCodes"] = 'target_language_codes_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).batch_translate_document._get_unset_required_fields(jsonified_request) - 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 "sourceLanguageCode" in jsonified_request - assert jsonified_request["sourceLanguageCode"] == 'source_language_code_value' - assert "targetLanguageCodes" in jsonified_request - assert jsonified_request["targetLanguageCodes"] == 'target_language_codes_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.batch_translate_document(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_batch_translate_document_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.batch_translate_document._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "sourceLanguageCode", "targetLanguageCodes", "inputConfigs", "outputConfig", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_batch_translate_document_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_batch_translate_document") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_batch_translate_document") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.BatchTranslateDocumentRequest.pb(translation_service.BatchTranslateDocumentRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.BatchTranslateDocumentRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.batch_translate_document(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_batch_translate_document_rest_bad_request(transport: str = 'rest', request_type=translation_service.BatchTranslateDocumentRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.batch_translate_document(request) - - -def test_batch_translate_document_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.batch_translate_document(**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/v3beta1/{parent=projects/*/locations/*}:batchTranslateDocument" % client.transport._host, args[1]) - - -def test_batch_translate_document_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.batch_translate_document( - translation_service.BatchTranslateDocumentRequest(), - parent='parent_value', - source_language_code='source_language_code_value', - target_language_codes=['target_language_codes_value'], - input_configs=[translation_service.BatchDocumentInputConfig(gcs_source=translation_service.GcsSource(input_uri='input_uri_value'))], - output_config=translation_service.BatchDocumentOutputConfig(gcs_destination=translation_service.GcsDestination(output_uri_prefix='output_uri_prefix_value')), - ) - - -def test_batch_translate_document_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.CreateGlossaryRequest, - dict, -]) -def test_create_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - request_init["glossary"] = {'name': 'name_value', 'language_pair': {'source_language_code': 'source_language_code_value', 'target_language_code': 'target_language_code_value'}, 'language_codes_set': {'language_codes': ['language_codes_value1', 'language_codes_value2']}, 'input_config': {'gcs_source': {'input_uri': 'input_uri_value'}}, 'entry_count': 1210, 'submit_time': {'seconds': 751, 'nanos': 543}, 'end_time': {}} - # 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 = translation_service.CreateGlossaryRequest.meta.fields["glossary"] - - 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["glossary"].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["glossary"][field])): - del request_init["glossary"][field][i][subfield] - else: - del request_init["glossary"][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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.create_glossary(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_create_glossary_rest_required_fields(request_type=translation_service.CreateGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_glossary._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_glossary._get_unset_required_fields(jsonified_request) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.create_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "glossary", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_create_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_create_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.CreateGlossaryRequest.pb(translation_service.CreateGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.CreateGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.create_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_create_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.CreateGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.create_glossary(request) - - -def test_create_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.create_glossary(**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/v3beta1/{parent=projects/*/locations/*}/glossaries" % client.transport._host, args[1]) - - -def test_create_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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_glossary( - translation_service.CreateGlossaryRequest(), - parent='parent_value', - glossary=translation_service.Glossary(name='name_value'), - ) - - -def test_create_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.ListGlossariesRequest, - dict, -]) -def test_list_glossaries_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = translation_service.ListGlossariesResponse( - next_page_token='next_page_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.ListGlossariesResponse.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 - response = client.list_glossaries(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListGlossariesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_glossaries_rest_required_fields(request_type=translation_service.ListGlossariesRequest): - transport_class = transports.TranslationServiceRestTransport - - 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, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_glossaries._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()).list_glossaries._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("filter", "page_size", "page_token", )) - 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 = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.ListGlossariesResponse() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.ListGlossariesResponse.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 - - response = client.list_glossaries(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_glossaries_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_glossaries._get_unset_required_fields({}) - assert set(unset_fields) == (set(("filter", "pageSize", "pageToken", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_glossaries_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_list_glossaries") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_list_glossaries") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.ListGlossariesRequest.pb(translation_service.ListGlossariesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.ListGlossariesResponse.to_json(translation_service.ListGlossariesResponse()) - - request = translation_service.ListGlossariesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.ListGlossariesResponse() - - client.list_glossaries(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_glossaries_rest_bad_request(transport: str = 'rest', request_type=translation_service.ListGlossariesRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'projects/sample1/locations/sample2'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_glossaries(request) - - -def test_list_glossaries_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.ListGlossariesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - filter='filter_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 = translation_service.ListGlossariesResponse.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 - - client.list_glossaries(**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/v3beta1/{parent=projects/*/locations/*}/glossaries" % client.transport._host, args[1]) - - -def test_list_glossaries_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.list_glossaries( - translation_service.ListGlossariesRequest(), - parent='parent_value', - filter='filter_value', - ) - - -def test_list_glossaries_rest_pager(transport: str = 'rest'): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # TODO(kbandes): remove this mock unless there's a good reason for it. - #with mock.patch.object(path_template, 'transcode') as transcode: - # Set the response as a series of pages - response = ( - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - translation_service.Glossary(), - ], - next_page_token='abc', - ), - translation_service.ListGlossariesResponse( - glossaries=[], - next_page_token='def', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - ], - next_page_token='ghi', - ), - translation_service.ListGlossariesResponse( - glossaries=[ - translation_service.Glossary(), - translation_service.Glossary(), - ], - ), - ) - # Two responses for two calls - response = response + response - - # Wrap the values into proper Response objs - response = tuple(translation_service.ListGlossariesResponse.to_json(x) for x in response) - return_values = tuple(Response() for i in response) - for return_val, response_val in zip(return_values, response): - return_val._content = response_val.encode('UTF-8') - return_val.status_code = 200 - req.side_effect = return_values - - sample_request = {'parent': 'projects/sample1/locations/sample2'} - - pager = client.list_glossaries(request=sample_request) - - results = list(pager) - assert len(results) == 6 - assert all(isinstance(i, translation_service.Glossary) - for i in results) - - pages = list(client.list_glossaries(request=sample_request).pages) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - - -@pytest.mark.parametrize("request_type", [ - translation_service.GetGlossaryRequest, - dict, -]) -def test_get_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = translation_service.Glossary( - name='name_value', - entry_count=1210, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = translation_service.Glossary.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 - response = client.get_glossary(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, translation_service.Glossary) - assert response.name == 'name_value' - assert response.entry_count == 1210 - - -def test_get_glossary_rest_required_fields(request_type=translation_service.GetGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = translation_service.Glossary() - # 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': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = translation_service.Glossary.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 - - response = client.get_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(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.TranslationServiceRestInterceptor, "post_get_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_get_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.GetGlossaryRequest.pb(translation_service.GetGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = translation_service.Glossary.to_json(translation_service.Glossary()) - - request = translation_service.GetGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = translation_service.Glossary() - - client.get_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.GetGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_glossary(request) - - -def test_get_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = translation_service.Glossary() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_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 = translation_service.Glossary.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 - - client.get_glossary(**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/v3beta1/{name=projects/*/locations/*/glossaries/*}" % client.transport._host, args[1]) - - -def test_get_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.get_glossary( - translation_service.GetGlossaryRequest(), - name='name_value', - ) - - -def test_get_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - translation_service.DeleteGlossaryRequest, - dict, -]) -def test_delete_glossary_rest(request_type): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = operations_pb2.Operation(name='operations/spam') - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_glossary(request) - - # Establish that the response is the type that we expect. - assert response.operation.name == "operations/spam" - - -def test_delete_glossary_rest_required_fields(request_type=translation_service.DeleteGlossaryRequest): - transport_class = transports.TranslationServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_glossary._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = operations_pb2.Operation(name='operations/spam') - # 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': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_glossary(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_glossary_rest_unset_required_fields(): - transport = transports.TranslationServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_glossary._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_glossary_rest_interceptors(null_interceptor): - transport = transports.TranslationServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.TranslationServiceRestInterceptor(), - ) - client = TranslationServiceClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(operation.Operation, "_set_result_from_operation"), \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "post_delete_glossary") as post, \ - mock.patch.object(transports.TranslationServiceRestInterceptor, "pre_delete_glossary") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = translation_service.DeleteGlossaryRequest.pb(translation_service.DeleteGlossaryRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = json_format.MessageToJson(operations_pb2.Operation()) - - request = translation_service.DeleteGlossaryRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = operations_pb2.Operation() - - client.delete_glossary(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_delete_glossary_rest_bad_request(transport: str = 'rest', request_type=translation_service.DeleteGlossaryRequest): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - 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 = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_glossary(request) - - -def test_delete_glossary_rest_flattened(): - client = TranslationServiceClient( - 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 = operations_pb2.Operation(name='operations/spam') - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'projects/sample1/locations/sample2/glossaries/sample3'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_glossary(**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/v3beta1/{name=projects/*/locations/*/glossaries/*}" % client.transport._host, args[1]) - - -def test_delete_glossary_rest_flattened_error(transport: str = 'rest'): - client = TranslationServiceClient( - 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.delete_glossary( - translation_service.DeleteGlossaryRequest(), - name='name_value', - ) - - -def test_delete_glossary_rest_error(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = TranslationServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = TranslationServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.TranslationServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.TranslationServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - transports.TranslationServiceRestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = TranslationServiceClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.TranslationServiceGrpcTransport, - ) - -def test_translation_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.TranslationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_translation_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.translate_v3beta1.services.translation_service.transports.TranslationServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.TranslationServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'translate_text', - 'detect_language', - 'get_supported_languages', - 'translate_document', - 'batch_translate_text', - 'batch_translate_document', - 'create_glossary', - 'list_glossaries', - 'get_glossary', - 'delete_glossary', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_translation_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.cloud.translate_v3beta1.services.translation_service.transports.TranslationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.TranslationServiceTransport( - 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/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - quota_project_id="octopus", - ) - - -def test_translation_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.cloud.translate_v3beta1.services.translation_service.transports.TranslationServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.TranslationServiceTransport() - adc.assert_called_once() - - -def test_translation_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) - TranslationServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - ], -) -def test_translation_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/cloud-platform', 'https://www.googleapis.com/auth/cloud-translation',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.TranslationServiceGrpcTransport, - transports.TranslationServiceGrpcAsyncIOTransport, - transports.TranslationServiceRestTransport, - ], -) -def test_translation_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.TranslationServiceGrpcTransport, grpc_helpers), - (transports.TranslationServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_translation_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( - "translate.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-translation', -), - scopes=["1", "2"], - default_host="translate.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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_translation_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.TranslationServiceRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -def test_translation_service_rest_lro_client(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.AbstractOperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_translation_service_host_no_port(transport_name): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='translate.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'translate.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://translate.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_translation_service_host_with_port(transport_name): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='translate.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'translate.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://translate.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_translation_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = TranslationServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = TranslationServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.translate_text._session - session2 = client2.transport.translate_text._session - assert session1 != session2 - session1 = client1.transport.detect_language._session - session2 = client2.transport.detect_language._session - assert session1 != session2 - session1 = client1.transport.get_supported_languages._session - session2 = client2.transport.get_supported_languages._session - assert session1 != session2 - session1 = client1.transport.translate_document._session - session2 = client2.transport.translate_document._session - assert session1 != session2 - session1 = client1.transport.batch_translate_text._session - session2 = client2.transport.batch_translate_text._session - assert session1 != session2 - session1 = client1.transport.batch_translate_document._session - session2 = client2.transport.batch_translate_document._session - assert session1 != session2 - session1 = client1.transport.create_glossary._session - session2 = client2.transport.create_glossary._session - assert session1 != session2 - session1 = client1.transport.list_glossaries._session - session2 = client2.transport.list_glossaries._session - assert session1 != session2 - session1 = client1.transport.get_glossary._session - session2 = client2.transport.get_glossary._session - assert session1 != session2 - session1 = client1.transport.delete_glossary._session - session2 = client2.transport.delete_glossary._session - assert session1 != session2 -def test_translation_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.TranslationServiceGrpcTransport( - 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_translation_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.TranslationServiceGrpcAsyncIOTransport( - 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.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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.TranslationServiceGrpcTransport, transports.TranslationServiceGrpcAsyncIOTransport]) -def test_translation_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_translation_service_grpc_lro_client(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_translation_service_grpc_lro_async_client(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - transport = client.transport - - # Ensure that we have a api-core operations client. - assert isinstance( - transport.operations_client, - operations_v1.OperationsAsyncClient, - ) - - # Ensure that subsequent calls to the property send the exact same object. - assert transport.operations_client is transport.operations_client - - -def test_glossary_path(): - project = "squid" - location = "clam" - glossary = "whelk" - expected = "projects/{project}/locations/{location}/glossaries/{glossary}".format(project=project, location=location, glossary=glossary, ) - actual = TranslationServiceClient.glossary_path(project, location, glossary) - assert expected == actual - - -def test_parse_glossary_path(): - expected = { - "project": "octopus", - "location": "oyster", - "glossary": "nudibranch", - } - path = TranslationServiceClient.glossary_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_glossary_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "cuttlefish" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = TranslationServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "mussel", - } - path = TranslationServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "winkle" - expected = "folders/{folder}".format(folder=folder, ) - actual = TranslationServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "nautilus", - } - path = TranslationServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "scallop" - expected = "organizations/{organization}".format(organization=organization, ) - actual = TranslationServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "abalone", - } - path = TranslationServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "squid" - expected = "projects/{project}".format(project=project, ) - actual = TranslationServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "clam", - } - path = TranslationServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "whelk" - location = "octopus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = TranslationServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "oyster", - "location": "nudibranch", - } - path = TranslationServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = TranslationServiceClient.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.TranslationServiceTransport, '_prep_wrapped_messages') as prep: - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.TranslationServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = TranslationServiceClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = TranslationServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - 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(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = TranslationServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "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 = TranslationServiceClient( - 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", [ - (TranslationServiceClient, transports.TranslationServiceGrpcTransport), - (TranslationServiceAsyncClient, transports.TranslationServiceGrpcAsyncIOTransport), -]) -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, - 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/tests/unit/gapic/translate_v3/test_translation_service.py b/tests/unit/gapic/translate_v3/test_translation_service.py index 99dbe1db..d71f43ef 100644 --- a/tests/unit/gapic/translate_v3/test_translation_service.py +++ b/tests/unit/gapic/translate_v3/test_translation_service.py @@ -4996,7 +4996,8 @@ def get_message_fields(field): if is_field_type_proto_plus_type: message_fields = field.message.meta.fields.values() - else: + # 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 @@ -5009,7 +5010,8 @@ def 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 - for field, value in request_init["glossary"].items(): + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["glossary"].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -5032,7 +5034,8 @@ def get_message_fields(field): ) # Remove fields from the sample request which are not present in the runtime version of the dependency - for subfield_to_delete in subfields_not_in_runtime: + # 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") diff --git a/tests/unit/gapic/translate_v3beta1/test_translation_service.py b/tests/unit/gapic/translate_v3beta1/test_translation_service.py index 7f00cd09..56cdfe49 100644 --- a/tests/unit/gapic/translate_v3beta1/test_translation_service.py +++ b/tests/unit/gapic/translate_v3beta1/test_translation_service.py @@ -4795,7 +4795,8 @@ def get_message_fields(field): if is_field_type_proto_plus_type: message_fields = field.message.meta.fields.values() - else: + # 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 @@ -4808,7 +4809,8 @@ def 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 - for field, value in request_init["glossary"].items(): + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["glossary"].items(): # pragma: NO COVER result = None is_repeated = False # For repeated fields @@ -4831,7 +4833,8 @@ def get_message_fields(field): ) # Remove fields from the sample request which are not present in the runtime version of the dependency - for subfield_to_delete in subfields_not_in_runtime: + # 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")