From a2bfa4d9c9c09712c74617924e36c2b4b9212cd8 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Mon, 21 Jun 2021 23:58:34 +0000 Subject: [PATCH 1/4] chore: remove all monolith Bazel deps chore: release gapic-generator-csharp v1.3.7 chore: release gapic-generator-go 0.20.5 chore: release gapic-generator-java 1.0.14 chore: release gapic-generator-php 1.0.1 chore: release gapic-generator-python 0.50.0 chore: update gapic-generator-ruby to the latest commit chore: release gapic-generator-typescript 1.5.0 Committer: @miraleung PiperOrigin-RevId: 380641501 Source-Link: https://github.com/googleapis/googleapis/commit/076f7e9f0b258bdb54338895d7251b202e8f0de3 Source-Link: https://github.com/googleapis/googleapis-gen/commit/27e4c88b4048e5f56508d4e1aa417d60a3380892 --- owl-bot-staging/v1/.coveragerc | 17 + owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/conf.py | 376 ++ owl-bot-staging/v1/docs/index.rst | 7 + .../v1/docs/speech_v1/services.rst | 6 + owl-bot-staging/v1/docs/speech_v1/speech.rst | 6 + owl-bot-staging/v1/docs/speech_v1/types.rst | 7 + .../v1/google/cloud/speech/__init__.py | 57 + .../v1/google/cloud/speech/py.typed | 2 + .../v1/google/cloud/speech_v1/__init__.py | 58 + .../cloud/speech_v1/gapic_metadata.json | 53 + .../v1/google/cloud/speech_v1/py.typed | 2 + .../cloud/speech_v1/services/__init__.py | 15 + .../speech_v1/services/speech/__init__.py | 22 + .../speech_v1/services/speech/async_client.py | 464 +++ .../cloud/speech_v1/services/speech/client.py | 624 +++ .../services/speech/transports/__init__.py | 33 + .../services/speech/transports/base.py | 217 + .../services/speech/transports/grpc.py | 328 ++ .../speech/transports/grpc_asyncio.py | 332 ++ .../google/cloud/speech_v1/types/__init__.py | 54 + .../cloud/speech_v1/types/cloud_speech.py | 989 +++++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 132 + .../v1/scripts/fixup_speech_v1_keywords.py | 178 + owl-bot-staging/v1/setup.py | 53 + owl-bot-staging/v1/tests/__init__.py | 16 + owl-bot-staging/v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../v1/tests/unit/gapic/speech_v1/__init__.py | 16 + .../tests/unit/gapic/speech_v1/test_speech.py | 1362 ++++++ owl-bot-staging/v1p1beta1/.coveragerc | 17 + owl-bot-staging/v1p1beta1/MANIFEST.in | 2 + owl-bot-staging/v1p1beta1/README.rst | 49 + owl-bot-staging/v1p1beta1/docs/conf.py | 376 ++ owl-bot-staging/v1p1beta1/docs/index.rst | 7 + .../docs/speech_v1p1beta1/adaptation.rst | 10 + .../docs/speech_v1p1beta1/services.rst | 7 + .../docs/speech_v1p1beta1/speech.rst | 6 + .../v1p1beta1/docs/speech_v1p1beta1/types.rst | 7 + .../v1p1beta1/google/cloud/speech/__init__.py | 93 + .../v1p1beta1/google/cloud/speech/py.typed | 2 + .../google/cloud/speech_v1p1beta1/__init__.py | 94 + .../speech_v1p1beta1/gapic_metadata.json | 167 + .../google/cloud/speech_v1p1beta1/py.typed | 2 + .../speech_v1p1beta1/services/__init__.py | 15 + .../services/adaptation/__init__.py | 22 + .../services/adaptation/async_client.py | 1015 +++++ .../services/adaptation/client.py | 1211 ++++++ .../services/adaptation/pagers.py | 263 ++ .../adaptation/transports/__init__.py | 33 + .../services/adaptation/transports/base.py | 296 ++ .../services/adaptation/transports/grpc.py | 488 +++ .../adaptation/transports/grpc_asyncio.py | 492 +++ .../services/speech/__init__.py | 22 + .../services/speech/async_client.py | 468 +++ .../services/speech/client.py | 646 +++ .../services/speech/transports/__init__.py | 33 + .../services/speech/transports/base.py | 217 + .../services/speech/transports/grpc.py | 328 ++ .../speech/transports/grpc_asyncio.py | 332 ++ .../cloud/speech_v1p1beta1/types/__init__.py | 90 + .../speech_v1p1beta1/types/cloud_speech.py | 1190 ++++++ .../types/cloud_speech_adaptation.py | 335 ++ .../cloud/speech_v1p1beta1/types/resource.py | 195 + owl-bot-staging/v1p1beta1/mypy.ini | 3 + owl-bot-staging/v1p1beta1/noxfile.py | 132 + .../fixup_speech_v1p1beta1_keywords.py | 188 + owl-bot-staging/v1p1beta1/setup.py | 53 + owl-bot-staging/v1p1beta1/tests/__init__.py | 16 + .../v1p1beta1/tests/unit/__init__.py | 16 + .../v1p1beta1/tests/unit/gapic/__init__.py | 16 + .../unit/gapic/speech_v1p1beta1/__init__.py | 16 + .../gapic/speech_v1p1beta1/test_adaptation.py | 3689 +++++++++++++++++ .../gapic/speech_v1p1beta1/test_speech.py | 1406 +++++++ 76 files changed, 19577 insertions(+) create mode 100644 owl-bot-staging/v1/.coveragerc create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/speech_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/speech_v1/speech.rst create mode 100644 owl-bot-staging/v1/docs/speech_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/speech/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py create mode 100644 owl-bot-staging/v1p1beta1/.coveragerc create mode 100644 owl-bot-staging/v1p1beta1/MANIFEST.in create mode 100644 owl-bot-staging/v1p1beta1/README.rst create mode 100644 owl-bot-staging/v1p1beta1/docs/conf.py create mode 100644 owl-bot-staging/v1p1beta1/docs/index.rst create mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst create mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst create mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst create mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py create mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py create mode 100644 owl-bot-staging/v1p1beta1/mypy.ini create mode 100644 owl-bot-staging/v1p1beta1/noxfile.py create mode 100644 owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py create mode 100644 owl-bot-staging/v1p1beta1/setup.py create mode 100644 owl-bot-staging/v1p1beta1/tests/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/tests/unit/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py create mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py create mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc new file mode 100644 index 00000000..f539ecf8 --- /dev/null +++ b/owl-bot-staging/v1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/speech/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 00000000..4a6fc4e7 --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/speech *.py +recursive-include google/cloud/speech_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 00000000..36384b14 --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Speech 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 Speech 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/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 00000000..567befa2 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-speech 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 = "1.6.3" + +# 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 master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-speech" +copyright = u"2020, 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 = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# 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-speech-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 = [ + ( + master_doc, + "google-cloud-speech.tex", + u"google-cloud-speech 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 = [ + ( + master_doc, + "google-cloud-speech", + u"Google Cloud Speech 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 = [ + ( + master_doc, + "google-cloud-speech", + u"google-cloud-speech Documentation", + author, + "google-cloud-speech", + "GAPIC library for Google Cloud Speech 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/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 00000000..20c367af --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + speech_v1/services + speech_v1/types diff --git a/owl-bot-staging/v1/docs/speech_v1/services.rst b/owl-bot-staging/v1/docs/speech_v1/services.rst new file mode 100644 index 00000000..07e11e84 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/services.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Speech v1 API +======================================= +.. toctree:: + :maxdepth: 2 + + speech diff --git a/owl-bot-staging/v1/docs/speech_v1/speech.rst b/owl-bot-staging/v1/docs/speech_v1/speech.rst new file mode 100644 index 00000000..53fc9d38 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/speech.rst @@ -0,0 +1,6 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v1.services.speech + :members: + :inherited-members: diff --git a/owl-bot-staging/v1/docs/speech_v1/types.rst b/owl-bot-staging/v1/docs/speech_v1/types.rst new file mode 100644 index 00000000..1ca37b89 --- /dev/null +++ b/owl-bot-staging/v1/docs/speech_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Speech v1 API +==================================== + +.. automodule:: google.cloud.speech_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech/__init__.py new file mode 100644 index 00000000..937aef0d --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech/__init__.py @@ -0,0 +1,57 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.speech_v1.services.speech.client import SpeechClient +from google.cloud.speech_v1.services.speech.async_client import SpeechAsyncClient + +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeMetadata +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import RecognitionAudio +from google.cloud.speech_v1.types.cloud_speech import RecognitionConfig +from google.cloud.speech_v1.types.cloud_speech import RecognitionMetadata +from google.cloud.speech_v1.types.cloud_speech import RecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import RecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import SpeakerDiarizationConfig +from google.cloud.speech_v1.types.cloud_speech import SpeechContext +from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionAlternative +from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionResult +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionConfig +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionResult +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeRequest +from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeResponse +from google.cloud.speech_v1.types.cloud_speech import WordInfo + +__all__ = ('SpeechClient', + 'SpeechAsyncClient', + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'WordInfo', +) diff --git a/owl-bot-staging/v1/google/cloud/speech/py.typed b/owl-bot-staging/v1/google/cloud/speech/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py new file mode 100644 index 00000000..55e62366 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py @@ -0,0 +1,58 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import LongRunningRecognizeMetadata +from .types.cloud_speech import LongRunningRecognizeRequest +from .types.cloud_speech import LongRunningRecognizeResponse +from .types.cloud_speech import RecognitionAudio +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionMetadata +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechContext +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import WordInfo + +__all__ = ( + 'SpeechAsyncClient', +'LongRunningRecognizeMetadata', +'LongRunningRecognizeRequest', +'LongRunningRecognizeResponse', +'RecognitionAudio', +'RecognitionConfig', +'RecognitionMetadata', +'RecognizeRequest', +'RecognizeResponse', +'SpeakerDiarizationConfig', +'SpeechClient', +'SpeechContext', +'SpeechRecognitionAlternative', +'SpeechRecognitionResult', +'StreamingRecognitionConfig', +'StreamingRecognitionResult', +'StreamingRecognizeRequest', +'StreamingRecognizeResponse', +'WordInfo', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json new file mode 100644 index 00000000..8775ccc2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json @@ -0,0 +1,53 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v1", + "protoPackage": "google.cloud.speech.v1", + "schema": "1.0", + "services": { + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/py.typed b/owl-bot-staging/v1/google/cloud/speech_v1/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py new file mode 100644 index 00000000..4de65971 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py new file mode 100644 index 00000000..13e0fa86 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + 'SpeechClient', + 'SpeechAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py new file mode 100644 index 00000000..7529ca84 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py @@ -0,0 +1,464 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1.types import cloud_speech +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Service that implements Google Cloud Speech API.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def recognize(self, + request: cloud_speech.RecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Args: + request (:class:`google.cloud.speech_v1.types.RecognizeRequest`): + The request object. The top-level message sent by the + client for the `Recognize` method. + config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def long_running_recognize(self, + request: cloud_speech.LongRunningRecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Args: + request (:class:`google.cloud.speech_v1.types.LongRunningRecognizeRequest`): + The request object. The top-level message sent by the + client for the `LongRunningRecognize` method. + config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.LongRunningRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.long_running_recognize, + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # 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, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: AsyncIterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Args: + requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]): + The request object AsyncIterator. The top-level message sent by the + client for the `StreamingRecognize` method. Multiple + `StreamingRecognizeRequest` messages are sent. The first + message must contain a `streaming_config` message and + must not contain `audio_content`. All subsequent + messages must contain `audio_content` and must not + contain a `streaming_config` message. + 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: + AsyncIterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of ten + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SpeechAsyncClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py new file mode 100644 index 00000000..ec1a669b --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py @@ -0,0 +1,624 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1.types import cloud_speech +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech 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[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[SpeechTransport]: + """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 SpeechClient(metaclass=SpeechClientMeta): + """Service that implements Google Cloud Speech API.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "speech.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: + SpeechClient: 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: + SpeechClient: 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) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @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 {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, SpeechTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.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. + 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() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # 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, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file: + 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: + 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, + ) + + def recognize(self, + request: cloud_speech.RecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Args: + request (google.cloud.speech_v1.types.RecognizeRequest): + The request object. The top-level message sent by the + client for the `Recognize` method. + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def long_running_recognize(self, + request: cloud_speech.LongRunningRecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Args: + request (google.cloud.speech_v1.types.LongRunningRecognizeRequest): + The request object. The top-level message sent by the + client for the `LongRunningRecognize` method. + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.LongRunningRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): + request = cloud_speech.LongRunningRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] + + # 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, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Iterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Args: + requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]): + The request object iterator. The top-level message sent by the + client for the `StreamingRecognize` method. Multiple + `StreamingRecognizeRequest` messages are sent. The first + message must contain a `streaming_config` message and + must not contain `audio_content`. All subsequent + messages must contain `audio_content` and must not + contain a `streaming_config` message. + 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: + Iterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of ten + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SpeechClient", +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py new file mode 100644 index 00000000..9f7015bc --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry['grpc'] = SpeechGrpcTransport +_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport + +__all__ = ( + 'SpeechTransport', + 'SpeechGrpcTransport', + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py new file mode 100644 index 00000000..2e119c5f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py @@ -0,0 +1,217 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-speech', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: 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, + **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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_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) + + # If the credentials is 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 + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + self.long_running_recognize: gapic_v1.method.wrap_method( + self.long_running_recognize, + default_timeout=5000.0, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + } + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, + Awaitable[cloud_speech.RecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'SpeechTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py new file mode 100644 index 00000000..a653aec0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py @@ -0,0 +1,328 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.api_core import gapic_v1 # type: ignore +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.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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 = 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: 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. + """ + # Sanity 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 recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + ~.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 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + +__all__ = ( + 'SpeechGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py new file mode 100644 index 00000000..d7a1b3a8 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,332 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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 = 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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. + """ + # Sanity 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 recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Awaitable[cloud_speech.RecognizeResponse]]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + 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 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse]]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + +__all__ = ( + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py new file mode 100644 index 00000000..a1cfdd55 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_speech import ( + LongRunningRecognizeMetadata, + LongRunningRecognizeRequest, + LongRunningRecognizeResponse, + RecognitionAudio, + RecognitionConfig, + RecognitionMetadata, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechContext, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + WordInfo, +) + +__all__ = ( + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'WordInfo', +) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py new file mode 100644 index 00000000..cb840a3a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py @@ -0,0 +1,989 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1', + manifest={ + 'RecognizeRequest', + 'LongRunningRecognizeRequest', + 'StreamingRecognizeRequest', + 'StreamingRecognitionConfig', + 'RecognitionConfig', + 'SpeakerDiarizationConfig', + 'RecognitionMetadata', + 'SpeechContext', + 'RecognitionAudio', + 'RecognizeResponse', + 'LongRunningRecognizeResponse', + 'LongRunningRecognizeMetadata', + 'StreamingRecognizeResponse', + 'StreamingRecognitionResult', + 'SpeechRecognitionResult', + 'SpeechRecognitionAlternative', + 'WordInfo', + }, +) + + +class RecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the ``Recognize`` + method. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be recognized. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + + +class LongRunningRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``LongRunningRecognize`` method. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1.types.RecognitionAudio): + Required. The audio data to be recognized. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The first message + must contain a ``streaming_config`` message and must not contain + ``audio_content``. All subsequent messages must contain + ``audio_content`` and must not contain a ``streaming_config`` + message. + + Attributes: + streaming_config (google.cloud.speech_v1.types.StreamingRecognitionConfig): + Provides information to the recognizer that specifies how to + process the request. The first ``StreamingRecognizeRequest`` + message must contain a ``streaming_config`` message. + audio_content (bytes): + The audio data to be recognized. Sequential chunks of audio + data are sent in sequential ``StreamingRecognizeRequest`` + messages. The first ``StreamingRecognizeRequest`` message + must not contain ``audio_content`` data and all subsequent + ``StreamingRecognizeRequest`` messages must contain + ``audio_content`` data. The audio bytes must be encoded as + specified in ``RecognitionConfig``. Note: as with all bytes + fields, proto buffers use a pure binary representation (not + base64). See `content + limits `__. + """ + + streaming_config = proto.Field( + proto.MESSAGE, + number=1, + oneof='streaming_request', + message='StreamingRecognitionConfig', + ) + audio_content = proto.Field( + proto.BYTES, + number=2, + oneof='streaming_request', + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + config (google.cloud.speech_v1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + single_utterance (bool): + If ``false`` or omitted, the recognizer will perform + continuous recognition (continuing to wait for and process + audio even if the user pauses speaking) until the client + closes the input stream (gRPC API) or until the maximum time + limit has been reached. May return multiple + ``StreamingRecognitionResult``\ s with the ``is_final`` flag + set to ``true``. + + If ``true``, the recognizer will detect a single spoken + utterance. When it detects that the user has paused or + stopped speaking, it will return an + ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It + will return no more than one ``StreamingRecognitionResult`` + with the ``is_final`` flag set to ``true``. + interim_results (bool): + If ``true``, interim results (tentative hypotheses) may be + returned as they become available (these interim results are + indicated with the ``is_final=false`` flag). If ``false`` or + omitted, only ``is_final=true`` result(s) are returned. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + single_utterance = proto.Field( + proto.BOOL, + number=2, + ) + interim_results = proto.Field( + proto.BOOL, + number=3, + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + encoding (google.cloud.speech_v1.types.RecognitionConfig.AudioEncoding): + Encoding of audio data sent in all ``RecognitionAudio`` + messages. This field is optional for ``FLAC`` and ``WAV`` + audio files and required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent in all + ``RecognitionAudio`` messages. Valid values are: 8000-48000. + 16000 is optimal. For best results, set the sampling rate of + the audio source to 16000 Hz. If that's not possible, use + the native sample rate of the audio source (instead of + re-sampling). This field is optional for FLAC and WAV audio + files, but is required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. + audio_channel_count (int): + The number of channels in the input audio data. ONLY set + this for MULTI-CHANNEL recognition. Valid values for + LINEAR16 and FLAC are ``1``-``8``. Valid values for OGG_OPUS + are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and + SPEEX_WITH_HEADER_BYTE is only ``1``. If ``0`` or omitted, + defaults to one channel (mono). Note: We only recognize the + first channel by default. To perform independent recognition + on each channel set + ``enable_separate_recognition_per_channel`` to 'true'. + enable_separate_recognition_per_channel (bool): + This needs to be set to ``true`` explicitly and + ``audio_channel_count`` > 1 to get each channel recognized + separately. The recognition result will contain a + ``channel_tag`` field to state which channel that result + belongs to. If this is not true, we will only recognize the + first channel. The request is billed cumulatively for all + channels recognized: ``audio_channel_count`` multiplied by + the length of the audio. + language_code (str): + Required. The language of the supplied audio as a + `BCP-47 `__ + language tag. Example: "en-US". See `Language + Support `__ + for a list of the currently supported language codes. + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. + Specifically, the maximum number of + ``SpeechRecognitionAlternative`` messages within each + ``SpeechRecognitionResult``. The server may return fewer + than ``max_alternatives``. Valid values are ``0``-``30``. A + value of ``0`` or ``1`` will return a maximum of one. If + omitted, will return a maximum of one. + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, e.g. "f***". If set to + ``false`` or omitted, profanities won't be filtered out. + speech_contexts (Sequence[google.cloud.speech_v1.types.SpeechContext]): + Array of + [SpeechContext][google.cloud.speech.v1.SpeechContext]. A + means to provide context to assist the speech recognition. + For more information, see `speech + adaptation `__. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_automatic_punctuation (bool): + If 'true', adds punctuation to recognition + result hypotheses. This feature is only + available in select languages. Setting this for + requests in other languages has no effect at + all. The default 'false' value does not add + punctuation to result hypotheses. Note: This is + currently offered as an experimental service, + complimentary to all users. In the future this + may be exclusively available as a premium + feature. + diarization_config (google.cloud.speech_v1.types.SpeakerDiarizationConfig): + Config to enable speaker diarization and set + additional parameters to make diarization better + suited for your application. Note: When this is + enabled, we send all the words from the + beginning of the audio for the top alternative + in every consecutive STREAMING responses. This + is done in order to improve our speaker tags as + our models learn to identify the speakers in the + conversation over time. For non-streaming + requests, the diarization results will be + provided only in the top alternative of the + FINAL SpeechRecognitionResult. + metadata (google.cloud.speech_v1.types.RecognitionMetadata): + Metadata regarding this request. + model (str): + Which model to select for the given request. Select the + model best suited to your domain to get best results. If a + model is not explicitly specified, then we auto-select a + model based on the parameters in the RecognitionConfig. + + .. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ModelDescription
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically + recorded at an 8khz sampling rate).
videoBest for audio that originated from from video or includes multiple + speakers. Ideally the audio is recorded at a 16khz or greater + sampling rate. This is a premium model that costs more than the + standard rate.
defaultBest for audio that is not one of the specific audio models. + For example, long-form audio. Ideally the audio is high-fidelity, + recorded at a 16khz or greater sampling rate.
+ use_enhanced (bool): + Set to true to use an enhanced model for speech recognition. + If ``use_enhanced`` is set to true and the ``model`` field + is not set, then an appropriate enhanced model is chosen if + an enhanced model exists for the audio. + + If ``use_enhanced`` is true and an enhanced version of the + specified model does not exist, then the speech is + recognized using the standard version of the specified + model. + """ + class AudioEncoding(proto.Enum): + r"""The encoding of the audio data sent in the request. + + All encodings support only 1 channel (mono) audio, unless the + ``audio_channel_count`` and + ``enable_separate_recognition_per_channel`` fields are set. + + For best results, the audio source should be captured and + transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). + The accuracy of the speech recognition can be reduced if lossy + codecs are used to capture or transmit audio, particularly if + background noise is present. Lossy codecs include ``MULAW``, + ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, and + ``MP3``. + + The ``FLAC`` and ``WAV`` audio file formats include a header that + describes the included audio content. You can request recognition + for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` + encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in + your request, you do not need to specify an ``AudioEncoding``; the + audio encoding format is determined from the file header. If you + specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` + audio, the encoding configuration must match the encoding described + in the audio header; otherwise the request returns an + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] + error code. + """ + ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + FLAC = 2 + MULAW = 3 + AMR = 4 + AMR_WB = 5 + OGG_OPUS = 6 + SPEEX_WITH_HEADER_BYTE = 7 + + encoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count = proto.Field( + proto.INT32, + number=7, + ) + enable_separate_recognition_per_channel = proto.Field( + proto.BOOL, + number=12, + ) + language_code = proto.Field( + proto.STRING, + number=3, + ) + max_alternatives = proto.Field( + proto.INT32, + number=4, + ) + profanity_filter = proto.Field( + proto.BOOL, + number=5, + ) + speech_contexts = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='SpeechContext', + ) + enable_word_time_offsets = proto.Field( + proto.BOOL, + number=8, + ) + enable_automatic_punctuation = proto.Field( + proto.BOOL, + number=11, + ) + diarization_config = proto.Field( + proto.MESSAGE, + number=19, + message='SpeakerDiarizationConfig', + ) + metadata = proto.Field( + proto.MESSAGE, + number=9, + message='RecognitionMetadata', + ) + model = proto.Field( + proto.STRING, + number=13, + ) + use_enhanced = proto.Field( + proto.BOOL, + number=14, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Config to enable speaker diarization. + Attributes: + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. + min_speaker_count (int): + Minimum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 2. + max_speaker_count (int): + Maximum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 6. + speaker_tag (int): + Unused. + """ + + enable_speaker_diarization = proto.Field( + proto.BOOL, + number=1, + ) + min_speaker_count = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count = proto.Field( + proto.INT32, + number=3, + ) + speaker_tag = proto.Field( + proto.INT32, + number=5, + ) + + +class RecognitionMetadata(proto.Message): + r"""Description of audio data to be recognized. + Attributes: + interaction_type (google.cloud.speech_v1.types.RecognitionMetadata.InteractionType): + The use case most closely describing the + audio content to be recognized. + industry_naics_code_of_audio (int): + The industry vertical to which this speech + recognition request most closely applies. This + is most indicative of the topics contained in + the audio. Use the 6-digit NAICS code to + identify the industry vertical - see + https://www.naics.com/search/. + microphone_distance (google.cloud.speech_v1.types.RecognitionMetadata.MicrophoneDistance): + The audio type that most closely describes + the audio being recognized. + original_media_type (google.cloud.speech_v1.types.RecognitionMetadata.OriginalMediaType): + The original media the speech was recorded + on. + recording_device_type (google.cloud.speech_v1.types.RecognitionMetadata.RecordingDeviceType): + The type of device the speech was recorded + with. + recording_device_name (str): + The device used to make the recording. + Examples 'Nexus 5X' or 'Polycom SoundStation IP + 6000' or 'POTS' or 'VoIP' or 'Cardioid + Microphone'. + original_mime_type (str): + Mime type of the original audio file. For example + ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, + ``audio/3gpp``. A list of possible audio mime types is + maintained at + http://www.iana.org/assignments/media-types/media-types.xhtml#audio + audio_topic (str): + Description of the content. Eg. "Recordings + of federal supreme court hearings from 2012". + """ + class InteractionType(proto.Enum): + r"""Use case categories that the audio recognition request can be + described by. + """ + INTERACTION_TYPE_UNSPECIFIED = 0 + DISCUSSION = 1 + PRESENTATION = 2 + PHONE_CALL = 3 + VOICEMAIL = 4 + PROFESSIONALLY_PRODUCED = 5 + VOICE_SEARCH = 6 + VOICE_COMMAND = 7 + DICTATION = 8 + + class MicrophoneDistance(proto.Enum): + r"""Enumerates the types of capture settings describing an audio + file. + """ + MICROPHONE_DISTANCE_UNSPECIFIED = 0 + NEARFIELD = 1 + MIDFIELD = 2 + FARFIELD = 3 + + class OriginalMediaType(proto.Enum): + r"""The original media the speech was recorded on.""" + ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 + AUDIO = 1 + VIDEO = 2 + + class RecordingDeviceType(proto.Enum): + r"""The type of device the speech was recorded with.""" + RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 + SMARTPHONE = 1 + PC = 2 + PHONE_LINE = 3 + VEHICLE = 4 + OTHER_OUTDOOR_DEVICE = 5 + OTHER_INDOOR_DEVICE = 6 + + interaction_type = proto.Field( + proto.ENUM, + number=1, + enum=InteractionType, + ) + industry_naics_code_of_audio = proto.Field( + proto.UINT32, + number=3, + ) + microphone_distance = proto.Field( + proto.ENUM, + number=4, + enum=MicrophoneDistance, + ) + original_media_type = proto.Field( + proto.ENUM, + number=5, + enum=OriginalMediaType, + ) + recording_device_type = proto.Field( + proto.ENUM, + number=6, + enum=RecordingDeviceType, + ) + recording_device_name = proto.Field( + proto.STRING, + number=7, + ) + original_mime_type = proto.Field( + proto.STRING, + number=8, + ) + audio_topic = proto.Field( + proto.STRING, + number=10, + ) + + +class SpeechContext(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + phrases (Sequence[str]): + A list of strings containing words and phrases "hints" so + that the speech recognition is more likely to recognize + them. This can be used to improve the accuracy for specific + words and phrases, for example, if specific commands are + typically spoken by the user. This can also be used to add + additional words to the vocabulary of the recognizer. See + `usage + limits `__. + + List items can also be set to classes for groups of words + that represent common concepts that occur in natural + language. For example, rather than providing phrase hints + for every month of the year, using the $MONTH class improves + the likelihood of correctly transcribing audio that includes + months. + """ + + phrases = proto.RepeatedField( + proto.STRING, + number=1, + ) + + +class RecognitionAudio(proto.Message): + r"""Contains audio data in the encoding specified in the + ``RecognitionConfig``. Either ``content`` or ``uri`` must be + supplied. Supplying both or neither returns + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + + Attributes: + content (bytes): + The audio data bytes encoded as specified in + ``RecognitionConfig``. Note: as with all bytes fields, proto + buffers use a pure binary representation, whereas JSON + representations use base64. + uri (str): + URI that points to a file that contains audio data bytes as + specified in ``RecognitionConfig``. The file must not be + compressed (for example, gzip). Currently, only Google Cloud + Storage URIs are supported, which must be specified in the + following format: ``gs://bucket_name/object_name`` (other + URI formats return + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + """ + + content = proto.Field( + proto.BYTES, + number=1, + oneof='audio_source', + ) + uri = proto.Field( + proto.STRING, + number=2, + oneof='audio_source', + ) + + +class RecognizeResponse(proto.Message): + r"""The only message returned to the client by the ``Recognize`` method. + It contains the result as zero or more sequential + ``SpeechRecognitionResult`` messages. + + Attributes: + results (Sequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + """ + + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + + +class LongRunningRecognizeResponse(proto.Message): + r"""The only message returned to the client by the + ``LongRunningRecognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. It is included + in the ``result.response`` field of the ``Operation`` returned by + the ``GetOperation`` call of the ``google::longrunning::Operations`` + service. + + Attributes: + results (Sequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + """ + + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + + +class LongRunningRecognizeMetadata(proto.Message): + r"""Describes the progress of a long-running ``LongRunningRecognize`` + call. It is included in the ``metadata`` field of the ``Operation`` + returned by the ``GetOperation`` call of the + ``google::longrunning::Operations`` service. + + Attributes: + progress_percent (int): + Approximate percentage of audio processed + thus far. Guaranteed to be 100 when the audio is + fully processed and the results are available. + start_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the request was received. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time of the most recent processing update. + """ + + progress_percent = proto.Field( + proto.INT32, + number=1, + ) + start_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + last_update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``StreamingRecognizeResponse`` is the only message returned to the + client by ``StreamingRecognize``. A series of zero or more + ``StreamingRecognizeResponse`` messages are streamed back to the + client. If there is no recognizable audio, and ``single_utterance`` + is set to false, then no messages are streamed back to the client. + + Here's an example of a series of ten + ``StreamingRecognizeResponse``\ s that might be returned while + processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. results { alternatives { transcript: " that is the question" + confidence: 0.98 } alternatives { transcript: " that was the + question" } is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain final results; + they are indicated by ``is_final: true``. Concatenating these + together generates the full transcript: "to be or not to be that + is the question". + + - The others contain interim ``results``. #3 and #6 contain two + interim ``results``: the first portion has a high stability and + is less likely to change; the second portion has a low stability + and is very likely to change. A UI designer might choose to show + only high stability ``results``. + + - The specific ``stability`` and ``confidence`` values shown above + are only for illustrative purposes. Actual values may vary. + + - In each response, only one of these fields will be set: + ``error``, ``speech_event_type``, or one or more (repeated) + ``results``. + + Attributes: + error (google.rpc.status_pb2.Status): + If set, returns a [google.rpc.Status][google.rpc.Status] + message that specifies the error for the operation. + results (Sequence[google.cloud.speech_v1.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one ``is_final=true`` + result (the newly settled portion), followed by zero or more + ``is_final=false`` results (the interim results). + speech_event_type (google.cloud.speech_v1.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + """ + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event.""" + SPEECH_EVENT_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + + error = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='StreamingRecognitionResult', + ) + speech_event_type = proto.Field( + proto.ENUM, + number=4, + enum=SpeechEventType, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (Sequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + is_final (bool): + If ``false``, this ``StreamingRecognitionResult`` represents + an interim result that may change. If ``true``, this is the + final time the speech service will return this particular + ``StreamingRecognitionResult``, the recognizer will not + return any further hypotheses for this portion of the + transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + (``is_final=false``). The default of 0.0 is a sentinel value + indicating ``stability`` was not set. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + language_code (str): + The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + is_final = proto.Field( + proto.BOOL, + number=2, + ) + stability = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_time = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag = proto.Field( + proto.INT32, + number=5, + ) + language_code = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (Sequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + channel_tag = proto.Field( + proto.INT32, + number=2, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (Sequence[google.cloud.speech_v1.types.WordInfo]): + A list of word-specific information for each recognized + word. Note: When ``enable_speaker_diarization`` is true, you + will see all the words from the beginning of the audio. + """ + + transcript = proto.Field( + proto.STRING, + number=1, + ) + confidence = proto.Field( + proto.FLOAT, + number=2, + ) + words = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='WordInfo', + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + Attributes: + start_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + end_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + word (str): + The word corresponding to this set of + information. + speaker_tag (int): + A distinct integer value is assigned for every speaker + within the audio. This field specifies which one of those + speakers was detected to have spoken this word. Value ranges + from '1' to diarization_speaker_count. speaker_tag is set if + enable_speaker_diarization = 'true' and only in the top + alternative. + """ + + start_time = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_time = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word = proto.Field( + proto.STRING, + number=3, + ) + speaker_tag = proto.Field( + proto.INT32, + number=5, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 00000000..4505b485 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 00000000..25e1412c --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +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") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/speech_v1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + 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='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py new file mode 100644 index 00000000..385dac85 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py @@ -0,0 +1,178 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +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 speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'long_running_recognize': ('config', 'audio', ), + 'recognize': ('config', 'audio', ), + 'streaming_recognize': ('streaming_config', 'audio_content', ), + } + + 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: not a.keyword.value 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=speechCallTransformer(), +): + """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 speech 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/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 00000000..1fe40131 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +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() + +setuptools.setup( + name='google-cloud-speech', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py new file mode 100644 index 00000000..4713b6e7 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py @@ -0,0 +1,1362 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +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_async # type: ignore +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1.services.speech import SpeechAsyncClient +from google.cloud.speech_v1.services.speech import SpeechClient +from google.cloud.speech_v1.services.speech import transports +from google.cloud.speech_v1.services.speech.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.speech_v1.types import cloud_speech +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.rpc import status_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +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 SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_from_service_account_info(client_class): + 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) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_service_account_always_use_jwt(client_class): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_from_service_account_file(client_class): + 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") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_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(SpeechClient, '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(SpeechClient, '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(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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + # 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() + + # 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() + + # 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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_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) + + 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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_speech_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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + 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, + ) + + +def test_speech_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient( + 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, + ) + + +def test_recognize(transport: str = 'grpc', request_type=cloud_speech.RecognizeRequest): + client = SpeechClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse( + ) + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +def test_recognize_from_dict(): + test_recognize(request_type=dict) + + +def test_recognize_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 = SpeechClient( + 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.recognize), + '__call__') as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + +@pytest.mark.asyncio +async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): + client = SpeechAsyncClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( + )) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +def test_recognize_flattened_error(): + client = SpeechClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_long_running_recognize(transport: str = 'grpc', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_long_running_recognize_from_dict(): + test_long_running_recognize(request_type=dict) + + +def test_long_running_recognize_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 = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + client.long_running_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + +@pytest.mark.asyncio +async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechAsyncClient( + 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.long_running_recognize), + '__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.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_long_running_recognize_async_from_dict(): + await test_long_running_recognize_async(request_type=dict) + + +def test_long_running_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__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.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +def test_long_running_recognize_flattened_error(): + client = SpeechClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__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.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_streaming_recognize(transport: str = 'grpc', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +def test_streaming_recognize_from_dict(): + test_streaming_recognize(request_type=dict) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechAsyncClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'recognize', + 'long_running_recognize', + 'streaming_recognize', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + +@requires_google_auth_gte_1_25_0 +def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + 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', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_speech_base_transport_with_credentials_file_old_google_auth(): + # 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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_speech_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) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_speech_auth_adc_old_google_auth(): + # 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) + SpeechClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_speech_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',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_speech_transport_auth_adc_old_google_auth(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") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_speech_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( + "speech.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_speech_host_no_port(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + ) + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_speech_host_with_port(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + ) + assert client.transport._host == 'speech.googleapis.com:8000' + +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + 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_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_speech_grpc_lro_client(): + client = SpeechClient( + 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_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + 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_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1p1beta1/.coveragerc b/owl-bot-staging/v1p1beta1/.coveragerc new file mode 100644 index 00000000..f539ecf8 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/speech/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1p1beta1/MANIFEST.in b/owl-bot-staging/v1p1beta1/MANIFEST.in new file mode 100644 index 00000000..1f464b43 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/speech *.py +recursive-include google/cloud/speech_v1p1beta1 *.py diff --git a/owl-bot-staging/v1p1beta1/README.rst b/owl-bot-staging/v1p1beta1/README.rst new file mode 100644 index 00000000..36384b14 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Speech 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 Speech 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/v1p1beta1/docs/conf.py b/owl-bot-staging/v1p1beta1/docs/conf.py new file mode 100644 index 00000000..567befa2 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-cloud-speech 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 = "1.6.3" + +# 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 master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-speech" +copyright = u"2020, 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 = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# 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-speech-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 = [ + ( + master_doc, + "google-cloud-speech.tex", + u"google-cloud-speech 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 = [ + ( + master_doc, + "google-cloud-speech", + u"Google Cloud Speech 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 = [ + ( + master_doc, + "google-cloud-speech", + u"google-cloud-speech Documentation", + author, + "google-cloud-speech", + "GAPIC library for Google Cloud Speech 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/v1p1beta1/docs/index.rst b/owl-bot-staging/v1p1beta1/docs/index.rst new file mode 100644 index 00000000..68cf3cee --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + speech_v1p1beta1/services + speech_v1p1beta1/types diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst new file mode 100644 index 00000000..7644e3ca --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst @@ -0,0 +1,10 @@ +Adaptation +---------------------------- + +.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation + :members: + :inherited-members: + +.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation.pagers + :members: + :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst new file mode 100644 index 00000000..d4982074 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Speech v1p1beta1 API +============================================== +.. toctree:: + :maxdepth: 2 + + adaptation + speech diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst new file mode 100644 index 00000000..bd3e379a --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst @@ -0,0 +1,6 @@ +Speech +------------------------ + +.. automodule:: google.cloud.speech_v1p1beta1.services.speech + :members: + :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst new file mode 100644 index 00000000..004a3819 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Speech v1p1beta1 API +=========================================== + +.. automodule:: google.cloud.speech_v1p1beta1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py new file mode 100644 index 00000000..8e8d26b4 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.speech_v1p1beta1.services.adaptation.client import AdaptationClient +from google.cloud.speech_v1p1beta1.services.adaptation.async_client import AdaptationAsyncClient +from google.cloud.speech_v1p1beta1.services.speech.client import SpeechClient +from google.cloud.speech_v1p1beta1.services.speech.async_client import SpeechAsyncClient + +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeMetadata +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionAudio +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionMetadata +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeakerDiarizationConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechContext +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionAlternative +from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionResult +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionResult +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech import TranscriptOutputConfig +from google.cloud.speech_v1p1beta1.types.cloud_speech import WordInfo +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreateCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreatePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeleteCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeletePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetPhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetResponse +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdateCustomClassRequest +from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdatePhraseSetRequest +from google.cloud.speech_v1p1beta1.types.resource import CustomClass +from google.cloud.speech_v1p1beta1.types.resource import PhraseSet +from google.cloud.speech_v1p1beta1.types.resource import SpeechAdaptation + +__all__ = ('AdaptationClient', + 'AdaptationAsyncClient', + 'SpeechClient', + 'SpeechAsyncClient', + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py new file mode 100644 index 00000000..5de2bbc1 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.adaptation import AdaptationClient +from .services.adaptation import AdaptationAsyncClient +from .services.speech import SpeechClient +from .services.speech import SpeechAsyncClient + +from .types.cloud_speech import LongRunningRecognizeMetadata +from .types.cloud_speech import LongRunningRecognizeRequest +from .types.cloud_speech import LongRunningRecognizeResponse +from .types.cloud_speech import RecognitionAudio +from .types.cloud_speech import RecognitionConfig +from .types.cloud_speech import RecognitionMetadata +from .types.cloud_speech import RecognizeRequest +from .types.cloud_speech import RecognizeResponse +from .types.cloud_speech import SpeakerDiarizationConfig +from .types.cloud_speech import SpeechContext +from .types.cloud_speech import SpeechRecognitionAlternative +from .types.cloud_speech import SpeechRecognitionResult +from .types.cloud_speech import StreamingRecognitionConfig +from .types.cloud_speech import StreamingRecognitionResult +from .types.cloud_speech import StreamingRecognizeRequest +from .types.cloud_speech import StreamingRecognizeResponse +from .types.cloud_speech import TranscriptOutputConfig +from .types.cloud_speech import WordInfo +from .types.cloud_speech_adaptation import CreateCustomClassRequest +from .types.cloud_speech_adaptation import CreatePhraseSetRequest +from .types.cloud_speech_adaptation import DeleteCustomClassRequest +from .types.cloud_speech_adaptation import DeletePhraseSetRequest +from .types.cloud_speech_adaptation import GetCustomClassRequest +from .types.cloud_speech_adaptation import GetPhraseSetRequest +from .types.cloud_speech_adaptation import ListCustomClassesRequest +from .types.cloud_speech_adaptation import ListCustomClassesResponse +from .types.cloud_speech_adaptation import ListPhraseSetRequest +from .types.cloud_speech_adaptation import ListPhraseSetResponse +from .types.cloud_speech_adaptation import UpdateCustomClassRequest +from .types.cloud_speech_adaptation import UpdatePhraseSetRequest +from .types.resource import CustomClass +from .types.resource import PhraseSet +from .types.resource import SpeechAdaptation + +__all__ = ( + 'AdaptationAsyncClient', + 'SpeechAsyncClient', +'AdaptationClient', +'CreateCustomClassRequest', +'CreatePhraseSetRequest', +'CustomClass', +'DeleteCustomClassRequest', +'DeletePhraseSetRequest', +'GetCustomClassRequest', +'GetPhraseSetRequest', +'ListCustomClassesRequest', +'ListCustomClassesResponse', +'ListPhraseSetRequest', +'ListPhraseSetResponse', +'LongRunningRecognizeMetadata', +'LongRunningRecognizeRequest', +'LongRunningRecognizeResponse', +'PhraseSet', +'RecognitionAudio', +'RecognitionConfig', +'RecognitionMetadata', +'RecognizeRequest', +'RecognizeResponse', +'SpeakerDiarizationConfig', +'SpeechAdaptation', +'SpeechClient', +'SpeechContext', +'SpeechRecognitionAlternative', +'SpeechRecognitionResult', +'StreamingRecognitionConfig', +'StreamingRecognitionResult', +'StreamingRecognizeRequest', +'StreamingRecognizeResponse', +'TranscriptOutputConfig', +'UpdateCustomClassRequest', +'UpdatePhraseSetRequest', +'WordInfo', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json new file mode 100644 index 00000000..3561c102 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.speech_v1p1beta1", + "protoPackage": "google.cloud.speech.v1p1beta1", + "schema": "1.0", + "services": { + "Adaptation": { + "clients": { + "grpc": { + "libraryClient": "AdaptationClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AdaptationAsyncClient", + "rpcs": { + "CreateCustomClass": { + "methods": [ + "create_custom_class" + ] + }, + "CreatePhraseSet": { + "methods": [ + "create_phrase_set" + ] + }, + "DeleteCustomClass": { + "methods": [ + "delete_custom_class" + ] + }, + "DeletePhraseSet": { + "methods": [ + "delete_phrase_set" + ] + }, + "GetCustomClass": { + "methods": [ + "get_custom_class" + ] + }, + "GetPhraseSet": { + "methods": [ + "get_phrase_set" + ] + }, + "ListCustomClasses": { + "methods": [ + "list_custom_classes" + ] + }, + "ListPhraseSet": { + "methods": [ + "list_phrase_set" + ] + }, + "UpdateCustomClass": { + "methods": [ + "update_custom_class" + ] + }, + "UpdatePhraseSet": { + "methods": [ + "update_phrase_set" + ] + } + } + } + } + }, + "Speech": { + "clients": { + "grpc": { + "libraryClient": "SpeechClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + }, + "grpc-async": { + "libraryClient": "SpeechAsyncClient", + "rpcs": { + "LongRunningRecognize": { + "methods": [ + "long_running_recognize" + ] + }, + "Recognize": { + "methods": [ + "recognize" + ] + }, + "StreamingRecognize": { + "methods": [ + "streaming_recognize" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed new file mode 100644 index 00000000..02081c09 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py new file mode 100644 index 00000000..4de65971 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py new file mode 100644 index 00000000..aa3e46a9 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import AdaptationClient +from .async_client import AdaptationAsyncClient + +__all__ = ( + 'AdaptationClient', + 'AdaptationAsyncClient', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py new file mode 100644 index 00000000..7ac601ef --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py @@ -0,0 +1,1015 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport +from .client import AdaptationClient + + +class AdaptationAsyncClient: + """Service that implements Google Cloud Speech Adaptation API.""" + + _client: AdaptationClient + + DEFAULT_ENDPOINT = AdaptationClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AdaptationClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(AdaptationClient.custom_class_path) + parse_custom_class_path = staticmethod(AdaptationClient.parse_custom_class_path) + phrase_set_path = staticmethod(AdaptationClient.phrase_set_path) + parse_phrase_set_path = staticmethod(AdaptationClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(AdaptationClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(AdaptationClient.parse_common_billing_account_path) + common_folder_path = staticmethod(AdaptationClient.common_folder_path) + parse_common_folder_path = staticmethod(AdaptationClient.parse_common_folder_path) + common_organization_path = staticmethod(AdaptationClient.common_organization_path) + parse_common_organization_path = staticmethod(AdaptationClient.parse_common_organization_path) + common_project_path = staticmethod(AdaptationClient.common_project_path) + parse_common_project_path = staticmethod(AdaptationClient.parse_common_project_path) + common_location_path = staticmethod(AdaptationClient.common_location_path) + parse_common_location_path = staticmethod(AdaptationClient.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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_info.__func__(AdaptationAsyncClient, 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: + AdaptationAsyncClient: The constructed client. + """ + return AdaptationClient.from_service_account_file.__func__(AdaptationAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(AdaptationClient).get_transport_class, type(AdaptationClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, AdaptationTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, ~.AdaptationTransport]): 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 = AdaptationClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_phrase_set(self, + request: cloud_speech_adaptation.CreatePhraseSetRequest = None, + *, + parent: str = None, + phrase_set: resource.PhraseSet = None, + phrase_set_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest`): + The request object. Message sent by the client for the + `CreatePhraseSet` method. + parent (:class:`str`): + Required. The parent resource where this phrase set will + be created. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (:class:`str`): + The ID to use for the phrase set, which will become the + final component of the phrase set's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity 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, phrase_set, phrase_set_id]) + 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 = cloud_speech_adaptation.CreatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # 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_phrase_set, + default_timeout=None, + 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_phrase_set(self, + request: cloud_speech_adaptation.GetPhraseSetRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest`): + The request object. Message sent by the client for the + `GetPhraseSet` method. + name (:class:`str`): + Required. The name of the phrase set to retrieve. + Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set, + default_timeout=None, + 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 list_phrase_set(self, + request: cloud_speech_adaptation.ListPhraseSetRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetAsyncPager: + r"""List phrase sets. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest`): + The request object. Message sent by the client for the + `ListPhraseSet` method. + parent (:class:`str`): + Required. The parent, which owns this + collection of phrase set. Format: + projects/{project}/locations/{location} + + 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.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetAsyncPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.ListPhraseSetRequest(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_phrase_set, + default_timeout=None, + 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.ListPhraseSetAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_phrase_set(self, + request: cloud_speech_adaptation.UpdatePhraseSetRequest = None, + *, + phrase_set: resource.PhraseSet = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest`): + The request object. Message sent by the client for the + `UpdatePhraseSet` method. + phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + The list of fields to be updated. + This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, update_mask]) + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_phrase_set, + default_timeout=None, + 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(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_phrase_set(self, + request: cloud_speech_adaptation.DeletePhraseSetRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest`): + The request object. Message sent by the client for the + `DeletePhraseSet` method. + name (:class:`str`): + Required. The name of the phrase set to delete. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + 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. + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.DeletePhraseSetRequest(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_phrase_set, + default_timeout=None, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def create_custom_class(self, + request: cloud_speech_adaptation.CreateCustomClassRequest = None, + *, + parent: str = None, + custom_class: resource.CustomClass = None, + custom_class_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest`): + The request object. Message sent by the client for the + `CreateCustomClass` method. + parent (:class:`str`): + Required. The parent resource where this custom class + will be created. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (:class:`str`): + The ID to use for the custom class, which will become + the final component of the custom class' resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity 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, custom_class, custom_class_id]) + 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 = cloud_speech_adaptation.CreateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # 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_custom_class, + default_timeout=None, + 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_custom_class(self, + request: cloud_speech_adaptation.GetCustomClassRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.GetCustomClassRequest`): + The request object. Message sent by the client for the + `GetCustomClass` method. + name (:class:`str`): + Required. The name of the custom class to retrieve. + Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class, + default_timeout=None, + 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 list_custom_classes(self, + request: cloud_speech_adaptation.ListCustomClassesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesAsyncPager: + r"""List custom classes. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest`): + The request object. Message sent by the client for the + `ListCustomClasses` method. + parent (:class:`str`): + Required. The parent, which owns this collection of + custom classes. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + + 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.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesAsyncPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.ListCustomClassesRequest(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_custom_classes, + default_timeout=None, + 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.ListCustomClassesAsyncPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_custom_class(self, + request: cloud_speech_adaptation.UpdateCustomClassRequest = None, + *, + custom_class: resource.CustomClass = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest`): + The request object. Message sent by the client for the + `UpdateCustomClass` method. + custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + The list of fields to be updated. + This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, update_mask]) + 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 = cloud_speech_adaptation.UpdateCustomClassRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_custom_class, + default_timeout=None, + 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(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_custom_class(self, + request: cloud_speech_adaptation.DeleteCustomClassRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest`): + The request object. Message sent by the client for the + `DeleteCustomClass` method. + name (:class:`str`): + Required. The name of the custom class to delete. + Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + 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. + """ + # Create or coerce a protobuf request object. + # Sanity 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 = cloud_speech_adaptation.DeleteCustomClassRequest(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_custom_class, + default_timeout=None, + 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "AdaptationAsyncClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py new file mode 100644 index 00000000..48386647 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py @@ -0,0 +1,1211 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import AdaptationGrpcTransport +from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport + + +class AdaptationClientMeta(type): + """Metaclass for the Adaptation 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[AdaptationTransport]] + _transport_registry["grpc"] = AdaptationGrpcTransport + _transport_registry["grpc_asyncio"] = AdaptationGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[AdaptationTransport]: + """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 AdaptationClient(metaclass=AdaptationClientMeta): + """Service that implements Google Cloud Speech Adaptation API.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "speech.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: + AdaptationClient: 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: + AdaptationClient: 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) -> AdaptationTransport: + """Returns the transport used by the client instance. + + Returns: + AdaptationTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?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 {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, AdaptationTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the adaptation 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, AdaptationTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.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. + 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() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # 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, AdaptationTransport): + # transport is a AdaptationTransport instance. + if credentials or client_options.credentials_file: + 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: + 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, + ) + + def create_phrase_set(self, + request: cloud_speech_adaptation.CreatePhraseSetRequest = None, + *, + parent: str = None, + phrase_set: resource.PhraseSet = None, + phrase_set_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Args: + request (google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest): + The request object. Message sent by the client for the + `CreatePhraseSet` method. + parent (str): + Required. The parent resource where this phrase set will + be created. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to create. + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + phrase_set_id (str): + The ID to use for the phrase set, which will become the + final component of the phrase set's resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``phrase_set_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity 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, phrase_set, phrase_set_id]) + 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 cloud_speech_adaptation.CreatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreatePhraseSetRequest): + request = cloud_speech_adaptation.CreatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if phrase_set is not None: + request.phrase_set = phrase_set + if phrase_set_id is not None: + request.phrase_set_id = phrase_set_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] + + # 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_phrase_set(self, + request: cloud_speech_adaptation.GetPhraseSetRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Get a phrase set. + + Args: + request (google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest): + The request object. Message sent by the client for the + `GetPhraseSet` method. + name (str): + Required. The name of the phrase set to retrieve. + Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.GetPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetPhraseSetRequest): + request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set] + + # 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 list_phrase_set(self, + request: cloud_speech_adaptation.ListPhraseSetRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListPhraseSetPager: + r"""List phrase sets. + + Args: + request (google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest): + The request object. Message sent by the client for the + `ListPhraseSet` method. + parent (str): + Required. The parent, which owns this + collection of phrase set. Format: + projects/{project}/locations/{location} + + 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.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetPager: + Message returned to the client by the ListPhraseSet + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.ListPhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListPhraseSetRequest): + request = cloud_speech_adaptation.ListPhraseSetRequest(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_phrase_set] + + # 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.ListPhraseSetPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_phrase_set(self, + request: cloud_speech_adaptation.UpdatePhraseSetRequest = None, + *, + phrase_set: resource.PhraseSet = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.PhraseSet: + r"""Update a phrase set. + + Args: + request (google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest): + The request object. Message sent by the client for the + `UpdatePhraseSet` method. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the + set to be updated. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + This corresponds to the ``phrase_set`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.PhraseSet: + Provides "hints" to the speech + recognizer to favor specific words and + phrases in the results. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([phrase_set, update_mask]) + 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 cloud_speech_adaptation.UpdatePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdatePhraseSetRequest): + request = cloud_speech_adaptation.UpdatePhraseSetRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if phrase_set is not None: + request.phrase_set = phrase_set + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_phrase_set] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("phrase_set.name", request.phrase_set.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_phrase_set(self, + request: cloud_speech_adaptation.DeletePhraseSetRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a phrase set. + + Args: + request (google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest): + The request object. Message sent by the client for the + `DeletePhraseSet` method. + name (str): + Required. The name of the phrase set to delete. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + + 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. + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.DeletePhraseSetRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeletePhraseSetRequest): + request = cloud_speech_adaptation.DeletePhraseSetRequest(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_phrase_set] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def create_custom_class(self, + request: cloud_speech_adaptation.CreateCustomClassRequest = None, + *, + parent: str = None, + custom_class: resource.CustomClass = None, + custom_class_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Create a custom class. + + Args: + request (google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest): + The request object. Message sent by the client for the + `CreateCustomClass` method. + parent (str): + Required. The parent resource where this custom class + will be created. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to create. + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + custom_class_id (str): + The ID to use for the custom class, which will become + the final component of the custom class' resource name. + + This value should be 4-63 characters, and valid + characters are /[a-z][0-9]-/. + + This corresponds to the ``custom_class_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity 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, custom_class, custom_class_id]) + 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 cloud_speech_adaptation.CreateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.CreateCustomClassRequest): + request = cloud_speech_adaptation.CreateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if custom_class is not None: + request.custom_class = custom_class + if custom_class_id is not None: + request.custom_class_id = custom_class_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_custom_class] + + # 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_custom_class(self, + request: cloud_speech_adaptation.GetCustomClassRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Get a custom class. + + Args: + request (google.cloud.speech_v1p1beta1.types.GetCustomClassRequest): + The request object. Message sent by the client for the + `GetCustomClass` method. + name (str): + Required. The name of the custom class to retrieve. + Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.GetCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.GetCustomClassRequest): + request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class] + + # 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 list_custom_classes(self, + request: cloud_speech_adaptation.ListCustomClassesRequest = None, + *, + parent: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> pagers.ListCustomClassesPager: + r"""List custom classes. + + Args: + request (google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest): + The request object. Message sent by the client for the + `ListCustomClasses` method. + parent (str): + Required. The parent, which owns this collection of + custom classes. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + + 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.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesPager: + Message returned to the client by the ListCustomClasses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.ListCustomClassesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.ListCustomClassesRequest): + request = cloud_speech_adaptation.ListCustomClassesRequest(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_custom_classes] + + # 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.ListCustomClassesPager( + method=rpc, + request=request, + response=response, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_custom_class(self, + request: cloud_speech_adaptation.UpdateCustomClassRequest = None, + *, + custom_class: resource.CustomClass = None, + update_mask: field_mask_pb2.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> resource.CustomClass: + r"""Update a custom class. + + Args: + request (google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest): + The request object. Message sent by the client for the + `UpdateCustomClass` method. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify + the custom class to be updated. Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + This corresponds to the ``custom_class`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.CustomClass: + A set of words or phrases that + represents a common concept likely to + appear in your audio, for example a list + of passenger ship names. CustomClass + items can be substituted into + placeholders that you set in PhraseSet + phrases. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([custom_class, update_mask]) + 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 cloud_speech_adaptation.UpdateCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.UpdateCustomClassRequest): + request = cloud_speech_adaptation.UpdateCustomClassRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if custom_class is not None: + request.custom_class = custom_class + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_custom_class] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("custom_class.name", request.custom_class.name), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_custom_class(self, + request: cloud_speech_adaptation.DeleteCustomClassRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Delete a custom class. + + Args: + request (google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest): + The request object. Message sent by the client for the + `DeleteCustomClass` method. + name (str): + Required. The name of the custom class to delete. + Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + + 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. + """ + # Create or coerce a protobuf request object. + # Sanity 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 cloud_speech_adaptation.DeleteCustomClassRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech_adaptation.DeleteCustomClassRequest): + request = cloud_speech_adaptation.DeleteCustomClassRequest(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_custom_class] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "AdaptationClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py new file mode 100644 index 00000000..b89b1ec5 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py @@ -0,0 +1,263 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from typing import Any, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource + + +class ListPhraseSetPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and + provides an ``__iter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` + 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[..., cloud_speech_adaptation.ListPhraseSetResponse], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + 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.speech_v1p1beta1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): + 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 = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[cloud_speech_adaptation.ListPhraseSetResponse]: + 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) -> Iterable[resource.PhraseSet]: + for page in self.pages: + yield from page.phrase_sets + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListPhraseSetAsyncPager: + """A pager for iterating through ``list_phrase_set`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``phrase_sets`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListPhraseSet`` requests and continue to iterate + through the ``phrase_sets`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` + 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[cloud_speech_adaptation.ListPhraseSetResponse]], + request: cloud_speech_adaptation.ListPhraseSetRequest, + response: cloud_speech_adaptation.ListPhraseSetResponse, + *, + 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.speech_v1p1beta1.types.ListPhraseSetRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): + 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 = cloud_speech_adaptation.ListPhraseSetRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[cloud_speech_adaptation.ListPhraseSetResponse]: + 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) -> AsyncIterable[resource.PhraseSet]: + async def async_generator(): + async for page in self.pages: + for response in page.phrase_sets: + yield response + + return async_generator() + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` + 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[..., cloud_speech_adaptation.ListCustomClassesResponse], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + 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.speech_v1p1beta1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): + 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 = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages(self) -> Iterable[cloud_speech_adaptation.ListCustomClassesResponse]: + 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) -> Iterable[resource.CustomClass]: + for page in self.pages: + yield from page.custom_classes + + def __repr__(self) -> str: + return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) + + +class ListCustomClassesAsyncPager: + """A pager for iterating through ``list_custom_classes`` requests. + + This class thinly wraps an initial + :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``custom_classes`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListCustomClasses`` requests and continue to iterate + through the ``custom_classes`` field on the + corresponding responses. + + All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` + 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[cloud_speech_adaptation.ListCustomClassesResponse]], + request: cloud_speech_adaptation.ListCustomClassesRequest, + response: cloud_speech_adaptation.ListCustomClassesResponse, + *, + 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.speech_v1p1beta1.types.ListCustomClassesRequest): + The initial request object. + response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): + 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 = cloud_speech_adaptation.ListCustomClassesRequest(request) + self._response = response + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages(self) -> AsyncIterable[cloud_speech_adaptation.ListCustomClassesResponse]: + 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) -> AsyncIterable[resource.CustomClass]: + async def async_generator(): + async for page in self.pages: + for response in page.custom_classes: + 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/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py new file mode 100644 index 00000000..d8329c94 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import AdaptationTransport +from .grpc import AdaptationGrpcTransport +from .grpc_asyncio import AdaptationGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[AdaptationTransport]] +_transport_registry['grpc'] = AdaptationGrpcTransport +_transport_registry['grpc_asyncio'] = AdaptationGrpcAsyncIOTransport + +__all__ = ( + 'AdaptationTransport', + 'AdaptationGrpcTransport', + 'AdaptationGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py new file mode 100644 index 00000000..58b668a8 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py @@ -0,0 +1,296 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import empty_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-speech', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class AdaptationTransport(abc.ABC): + """Abstract transport class for Adaptation.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: 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, + **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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_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) + + # If the credentials is 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 + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_phrase_set: gapic_v1.method.wrap_method( + self.create_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.get_phrase_set: gapic_v1.method.wrap_method( + self.get_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.list_phrase_set: gapic_v1.method.wrap_method( + self.list_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.update_phrase_set: gapic_v1.method.wrap_method( + self.update_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.delete_phrase_set: gapic_v1.method.wrap_method( + self.delete_phrase_set, + default_timeout=None, + client_info=client_info, + ), + self.create_custom_class: gapic_v1.method.wrap_method( + self.create_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.get_custom_class: gapic_v1.method.wrap_method( + self.get_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.list_custom_classes: gapic_v1.method.wrap_method( + self.list_custom_classes, + default_timeout=None, + client_info=client_info, + ), + self.update_custom_class: gapic_v1.method.wrap_method( + self.update_custom_class, + default_timeout=None, + client_info=client_info, + ), + self.delete_custom_class: gapic_v1.method.wrap_method( + self.delete_custom_class, + default_timeout=None, + client_info=client_info, + ), + } + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Union[ + cloud_speech_adaptation.ListPhraseSetResponse, + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse] + ]]: + raise NotImplementedError() + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Union[ + resource.PhraseSet, + Awaitable[resource.PhraseSet] + ]]: + raise NotImplementedError() + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Union[ + cloud_speech_adaptation.ListCustomClassesResponse, + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse] + ]]: + raise NotImplementedError() + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Union[ + resource.CustomClass, + Awaitable[resource.CustomClass] + ]]: + raise NotImplementedError() + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'AdaptationTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py new file mode 100644 index 00000000..45fb4a3b --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py @@ -0,0 +1,488 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +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.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO + + +class AdaptationGrpcTransport(AdaptationTransport): + """gRPC backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + ~.PhraseSet]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + cloud_speech_adaptation.ListPhraseSetResponse]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + ~.ListPhraseSetResponse]: + 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_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + resource.PhraseSet]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + ~.PhraseSet]: + 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 'update_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + ~.Empty]: + 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_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + ~.CustomClass]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + cloud_speech_adaptation.ListCustomClassesResponse]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + ~.ListCustomClassesResponse]: + 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_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + resource.CustomClass]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + ~.CustomClass]: + 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 'update_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + ~.Empty]: + 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_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + +__all__ = ( + 'AdaptationGrpcTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py new file mode 100644 index 00000000..eeddd3f0 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py @@ -0,0 +1,492 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import empty_pb2 # type: ignore +from .base import AdaptationTransport, DEFAULT_CLIENT_INFO +from .grpc import AdaptationGrpcTransport + + +class AdaptationGrpcAsyncIOTransport(AdaptationTransport): + """gRPC AsyncIO backend transport for Adaptation. + + Service that implements Google Cloud Speech Adaptation API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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 create_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.CreatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the create phrase set method over gRPC. + + Create a set of phrase hints. Each item in the set + can be a single word or a multi-word phrase. The items + in the PhraseSet are favored by the recognition model + when you send a call that includes the PhraseSet. + + Returns: + Callable[[~.CreatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', + request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['create_phrase_set'] + + @property + def get_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.GetPhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the get phrase set method over gRPC. + + Get a phrase set. + + Returns: + Callable[[~.GetPhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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_phrase_set' not in self._stubs: + self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', + request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['get_phrase_set'] + + @property + def list_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.ListPhraseSetRequest], + Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]]: + r"""Return a callable for the list phrase set method over gRPC. + + List phrase sets. + + Returns: + Callable[[~.ListPhraseSetRequest], + Awaitable[~.ListPhraseSetResponse]]: + 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_phrase_set' not in self._stubs: + self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', + request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, + ) + return self._stubs['list_phrase_set'] + + @property + def update_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.UpdatePhraseSetRequest], + Awaitable[resource.PhraseSet]]: + r"""Return a callable for the update phrase set method over gRPC. + + Update a phrase set. + + Returns: + Callable[[~.UpdatePhraseSetRequest], + Awaitable[~.PhraseSet]]: + 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 'update_phrase_set' not in self._stubs: + self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', + request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, + response_deserializer=resource.PhraseSet.deserialize, + ) + return self._stubs['update_phrase_set'] + + @property + def delete_phrase_set(self) -> Callable[ + [cloud_speech_adaptation.DeletePhraseSetRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete phrase set method over gRPC. + + Delete a phrase set. + + Returns: + Callable[[~.DeletePhraseSetRequest], + Awaitable[~.Empty]]: + 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_phrase_set' not in self._stubs: + self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', + request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_phrase_set'] + + @property + def create_custom_class(self) -> Callable[ + [cloud_speech_adaptation.CreateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the create custom class method over gRPC. + + Create a custom class. + + Returns: + Callable[[~.CreateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', + request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['create_custom_class'] + + @property + def get_custom_class(self) -> Callable[ + [cloud_speech_adaptation.GetCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the get custom class method over gRPC. + + Get a custom class. + + Returns: + Callable[[~.GetCustomClassRequest], + Awaitable[~.CustomClass]]: + 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_custom_class' not in self._stubs: + self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', + request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['get_custom_class'] + + @property + def list_custom_classes(self) -> Callable[ + [cloud_speech_adaptation.ListCustomClassesRequest], + Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]]: + r"""Return a callable for the list custom classes method over gRPC. + + List custom classes. + + Returns: + Callable[[~.ListCustomClassesRequest], + Awaitable[~.ListCustomClassesResponse]]: + 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_custom_classes' not in self._stubs: + self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', + request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, + response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, + ) + return self._stubs['list_custom_classes'] + + @property + def update_custom_class(self) -> Callable[ + [cloud_speech_adaptation.UpdateCustomClassRequest], + Awaitable[resource.CustomClass]]: + r"""Return a callable for the update custom class method over gRPC. + + Update a custom class. + + Returns: + Callable[[~.UpdateCustomClassRequest], + Awaitable[~.CustomClass]]: + 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 'update_custom_class' not in self._stubs: + self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', + request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, + response_deserializer=resource.CustomClass.deserialize, + ) + return self._stubs['update_custom_class'] + + @property + def delete_custom_class(self) -> Callable[ + [cloud_speech_adaptation.DeleteCustomClassRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete custom class method over gRPC. + + Delete a custom class. + + Returns: + Callable[[~.DeleteCustomClassRequest], + Awaitable[~.Empty]]: + 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_custom_class' not in self._stubs: + self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', + request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_custom_class'] + + +__all__ = ( + 'AdaptationGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py new file mode 100644 index 00000000..13e0fa86 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import SpeechClient +from .async_client import SpeechAsyncClient + +__all__ = ( + 'SpeechClient', + 'SpeechAsyncClient', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py new file mode 100644 index 00000000..760c4353 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py @@ -0,0 +1,468 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport +from .client import SpeechClient + + +class SpeechAsyncClient: + """Service that implements Google Cloud Speech API.""" + + _client: SpeechClient + + DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT + + custom_class_path = staticmethod(SpeechClient.custom_class_path) + parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) + phrase_set_path = staticmethod(SpeechClient.phrase_set_path) + parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) + common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) + common_folder_path = staticmethod(SpeechClient.common_folder_path) + parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) + common_organization_path = staticmethod(SpeechClient.common_organization_path) + parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) + common_project_path = staticmethod(SpeechClient.common_project_path) + parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) + common_location_path = staticmethod(SpeechClient.common_location_path) + parse_common_location_path = staticmethod(SpeechClient.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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: + SpeechAsyncClient: The constructed client. + """ + return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, SpeechTransport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def recognize(self, + request: cloud_speech.RecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.RecognizeRequest`): + The request object. The top-level message sent by the + client for the `Recognize` method. + config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.RecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def long_running_recognize(self, + request: cloud_speech.LongRunningRecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation_async.AsyncOperation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Args: + request (:class:`google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest`): + The request object. The top-level message sent by the + client for the `LongRunningRecognize` method. + config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 = cloud_speech.LongRunningRecognizeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.long_running_recognize, + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # 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, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: AsyncIterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Args: + requests (AsyncIterator[`google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest`]): + The request object AsyncIterator. The top-level message sent by the + client for the `StreamingRecognize` method. Multiple + `StreamingRecognizeRequest` messages are sent. The first + message must contain a `streaming_config` message and + must not contain `audio_content`. All subsequent + messages must contain `audio_content` and must not + contain a `streaming_config` message. + 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: + AsyncIterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.streaming_recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SpeechAsyncClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py new file mode 100644 index 00000000..69937262 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py @@ -0,0 +1,646 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.api_core import operation # type: ignore +from google.api_core import operation_async # type: ignore +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.rpc import status_pb2 # type: ignore +from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import SpeechGrpcTransport +from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport + + +class SpeechClientMeta(type): + """Metaclass for the Speech 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[SpeechTransport]] + _transport_registry["grpc"] = SpeechGrpcTransport + _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[SpeechTransport]: + """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 SpeechClient(metaclass=SpeechClientMeta): + """Service that implements Google Cloud Speech API.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "speech.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: + SpeechClient: 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: + SpeechClient: 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) -> SpeechTransport: + """Returns the transport used by the client instance. + + Returns: + SpeechTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def custom_class_path(project: str,location: str,custom_class: str,) -> str: + """Returns a fully-qualified custom_class string.""" + return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + + @staticmethod + def parse_custom_class_path(path: str) -> Dict[str,str]: + """Parses a custom_class path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: + """Returns a fully-qualified phrase_set string.""" + return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + + @staticmethod + def parse_phrase_set_path(path: str) -> Dict[str,str]: + """Parses a phrase_set path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?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 {} + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, SpeechTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the speech 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, SpeechTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.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. + 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() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + if is_mtls: + client_cert_source_func = mtls.default_client_cert_source() + else: + client_cert_source_func = None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + if is_mtls: + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " + "values: never, auto, always" + ) + + # 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, SpeechTransport): + # transport is a SpeechTransport instance. + if credentials or client_options.credentials_file: + 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: + 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, + ) + + def recognize(self, + request: cloud_speech.RecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> cloud_speech.RecognizeResponse: + r"""Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Args: + request (google.cloud.speech_v1p1beta1.types.RecognizeRequest): + The request object. The top-level message sent by the + client for the `Recognize` method. + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: + The only message returned to the client by the Recognize method. It + contains the result as zero or more sequential + SpeechRecognitionResult messages. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.RecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.RecognizeRequest): + request = cloud_speech.RecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.recognize] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def long_running_recognize(self, + request: cloud_speech.LongRunningRecognizeRequest = None, + *, + config: cloud_speech.RecognitionConfig = None, + audio: cloud_speech.RecognitionAudio = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> operation.Operation: + r"""Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Args: + request (google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest): + The request object. The top-level message sent by the + client for the `LongRunningRecognize` method. + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process + the request. + + This corresponds to the ``config`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be + recognized. + + This corresponds to the ``audio`` 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.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. + It contains the result as zero or more sequential + SpeechRecognitionResult messages. It is included in + the result.response field of the Operation returned + by the GetOperation call of the + google::longrunning::Operations service. + + """ + # Create or coerce a protobuf request object. + # Sanity check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([config, audio]) + 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 cloud_speech.LongRunningRecognizeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): + request = cloud_speech.LongRunningRecognizeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if config is not None: + request.config = config + if audio is not None: + request.audio = audio + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] + + # 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, + cloud_speech.LongRunningRecognizeResponse, + metadata_type=cloud_speech.LongRunningRecognizeMetadata, + ) + + # Done; return the response. + return response + + def streaming_recognize(self, + requests: Iterator[cloud_speech.StreamingRecognizeRequest] = None, + *, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: + r"""Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Args: + requests (Iterator[google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest]): + The request object iterator. The top-level message sent by the + client for the `StreamingRecognize` method. Multiple + `StreamingRecognizeRequest` messages are sent. The first + message must contain a `streaming_config` message and + must not contain `audio_content`. All subsequent + messages must contain `audio_content` and must not + contain a `streaming_config` message. + 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: + Iterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: + StreamingRecognizeResponse is the only message returned to the client by + StreamingRecognize. A series of zero or more + StreamingRecognizeResponse messages are streamed back + to the client. If there is no recognizable audio, and + single_utterance is set to false, then no messages + are streamed back to the client. + + Here's an example of a series of + StreamingRecognizeResponses that might be returned + while processing audio: + + 1. results { alternatives { transcript: "tube" } + stability: 0.01 } + 2. results { alternatives { transcript: "to be a" } + stability: 0.01 } + 3. results { alternatives { transcript: "to be" } + stability: 0.9 } results { alternatives { + transcript: " or not to be" } stability: 0.01 } + 4. + + results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } + + alternatives { transcript: "to bee or not to bee" } + is_final: true } + + 5. results { alternatives { transcript: " that's" } + stability: 0.01 } + 6. results { alternatives { transcript: " that is" } + stability: 0.9 } results { alternatives { + transcript: " the question" } stability: 0.01 } + 7. + + results { alternatives { transcript: " that is the question" + confidence: 0.98 } + + alternatives { transcript: " that was the question" } + is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain + final results; they are indicated by + is_final: true. Concatenating these together + generates the full transcript: "to be or not to be + that is the question". + - The others contain interim results. #3 and #6 + contain two interim \`results`: the first portion + has a high stability and is less likely to change; + the second portion has a low stability and is very + likely to change. A UI designer might choose to + show only high stability results. + - The specific stability and confidence values shown + above are only for illustrative purposes. Actual + values may vary. + - + + In each response, only one of these fields will be set: + error, speech_event_type, or one or more + (repeated) results. + + """ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] + + # Send the request. + response = rpc( + requests, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-speech", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "SpeechClient", +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py new file mode 100644 index 00000000..9f7015bc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import SpeechTransport +from .grpc import SpeechGrpcTransport +from .grpc_asyncio import SpeechGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] +_transport_registry['grpc'] = SpeechGrpcTransport +_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport + +__all__ = ( + 'SpeechTransport', + 'SpeechGrpcTransport', + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py new file mode 100644 index 00000000..8df6d724 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py @@ -0,0 +1,217 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import packaging.version +import pkg_resources + +import google.auth # type: ignore +import google.api_core # type: ignore +from google.api_core import exceptions as core_exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-speech', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +try: + # google.auth.__version__ was added in 1.26.0 + _GOOGLE_AUTH_VERSION = google.auth.__version__ +except AttributeError: + try: # try pkg_resources if it is available + _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version + except pkg_resources.DistributionNotFound: # pragma: NO COVER + _GOOGLE_AUTH_VERSION = None + + +class SpeechTransport(abc.ABC): + """Abstract transport class for Speech.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + ) + + DEFAULT_HOST: str = 'speech.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: 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, + **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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) + + # Save the scopes. + self._scopes = scopes or self.AUTH_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) + + # If the credentials is 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 + + # TODO(busunkim): This method is in the base transport + # to avoid duplicating code across the transport classes. These functions + # should be deleted once the minimum required versions of google-auth is increased. + + # TODO: Remove this function once google-auth >= 1.25.0 is required + @classmethod + def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: + """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" + + scopes_kwargs = {} + + if _GOOGLE_AUTH_VERSION and ( + packaging.version.parse(_GOOGLE_AUTH_VERSION) + >= packaging.version.parse("1.25.0") + ): + scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} + else: + scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} + + return scopes_kwargs + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.recognize: gapic_v1.method.wrap_method( + self.recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + self.long_running_recognize: gapic_v1.method.wrap_method( + self.long_running_recognize, + default_timeout=5000.0, + client_info=client_info, + ), + self.streaming_recognize: gapic_v1.method.wrap_method( + self.streaming_recognize, + 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=5000.0, + ), + default_timeout=5000.0, + client_info=client_info, + ), + } + + @property + def operations_client(self) -> operations_v1.OperationsClient: + """Return the client designed to process long-running operations.""" + raise NotImplementedError() + + @property + def recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Union[ + cloud_speech.RecognizeResponse, + Awaitable[cloud_speech.RecognizeResponse] + ]]: + raise NotImplementedError() + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Union[ + operations_pb2.Operation, + Awaitable[operations_pb2.Operation] + ]]: + raise NotImplementedError() + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Union[ + cloud_speech.StreamingRecognizeResponse, + Awaitable[cloud_speech.StreamingRecognizeResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'SpeechTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py new file mode 100644 index 00000000..ce51090b --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py @@ -0,0 +1,328 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.api_core import gapic_v1 # type: ignore +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.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO + + +class SpeechGrpcTransport(SpeechTransport): + """gRPC backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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 = 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: 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. + """ + # Sanity 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 recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + cloud_speech.RecognizeResponse]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + ~.RecognizeResponse]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + operations_pb2.Operation]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + ~.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 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + cloud_speech.StreamingRecognizeResponse]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + ~.StreamingRecognizeResponse]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + +__all__ = ( + 'SpeechGrpcTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py new file mode 100644 index 00000000..f155c6cd --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py @@ -0,0 +1,332 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google.api_core import operations_v1 # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +import packaging.version + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.longrunning import operations_pb2 # type: ignore +from .base import SpeechTransport, DEFAULT_CLIENT_INFO +from .grpc import SpeechGrpcTransport + + +class SpeechGrpcAsyncIOTransport(SpeechTransport): + """gRPC AsyncIO backend transport for Speech. + + Service that implements Google Cloud Speech API. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'speech.googleapis.com', + credentials: 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 = 'speech.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> 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 applicatin 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 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 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. + + 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 = 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=True, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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. + """ + # Sanity 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 recognize(self) -> Callable[ + [cloud_speech.RecognizeRequest], + Awaitable[cloud_speech.RecognizeResponse]]: + r"""Return a callable for the recognize method over gRPC. + + Performs synchronous speech recognition: receive + results after all audio has been sent and processed. + + Returns: + Callable[[~.RecognizeRequest], + Awaitable[~.RecognizeResponse]]: + 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 'recognize' not in self._stubs: + self._stubs['recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/Recognize', + request_serializer=cloud_speech.RecognizeRequest.serialize, + response_deserializer=cloud_speech.RecognizeResponse.deserialize, + ) + return self._stubs['recognize'] + + @property + def long_running_recognize(self) -> Callable[ + [cloud_speech.LongRunningRecognizeRequest], + Awaitable[operations_pb2.Operation]]: + r"""Return a callable for the long running recognize method over gRPC. + + Performs asynchronous speech recognition: receive results via + the google.longrunning.Operations interface. Returns either an + ``Operation.error`` or an ``Operation.response`` which contains + a ``LongRunningRecognizeResponse`` message. For more information + on asynchronous speech recognition, see the + `how-to `__. + + Returns: + Callable[[~.LongRunningRecognizeRequest], + 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 'long_running_recognize' not in self._stubs: + self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( + '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', + request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, + response_deserializer=operations_pb2.Operation.FromString, + ) + return self._stubs['long_running_recognize'] + + @property + def streaming_recognize(self) -> Callable[ + [cloud_speech.StreamingRecognizeRequest], + Awaitable[cloud_speech.StreamingRecognizeResponse]]: + r"""Return a callable for the streaming recognize method over gRPC. + + Performs bidirectional streaming speech recognition: + receive results while sending audio. This method is only + available via the gRPC API (not REST). + + Returns: + Callable[[~.StreamingRecognizeRequest], + Awaitable[~.StreamingRecognizeResponse]]: + 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 'streaming_recognize' not in self._stubs: + self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( + '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', + request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, + response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, + ) + return self._stubs['streaming_recognize'] + + +__all__ = ( + 'SpeechGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py new file mode 100644 index 00000000..91fa91e0 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .cloud_speech import ( + LongRunningRecognizeMetadata, + LongRunningRecognizeRequest, + LongRunningRecognizeResponse, + RecognitionAudio, + RecognitionConfig, + RecognitionMetadata, + RecognizeRequest, + RecognizeResponse, + SpeakerDiarizationConfig, + SpeechContext, + SpeechRecognitionAlternative, + SpeechRecognitionResult, + StreamingRecognitionConfig, + StreamingRecognitionResult, + StreamingRecognizeRequest, + StreamingRecognizeResponse, + TranscriptOutputConfig, + WordInfo, +) +from .cloud_speech_adaptation import ( + CreateCustomClassRequest, + CreatePhraseSetRequest, + DeleteCustomClassRequest, + DeletePhraseSetRequest, + GetCustomClassRequest, + GetPhraseSetRequest, + ListCustomClassesRequest, + ListCustomClassesResponse, + ListPhraseSetRequest, + ListPhraseSetResponse, + UpdateCustomClassRequest, + UpdatePhraseSetRequest, +) +from .resource import ( + CustomClass, + PhraseSet, + SpeechAdaptation, +) + +__all__ = ( + 'LongRunningRecognizeMetadata', + 'LongRunningRecognizeRequest', + 'LongRunningRecognizeResponse', + 'RecognitionAudio', + 'RecognitionConfig', + 'RecognitionMetadata', + 'RecognizeRequest', + 'RecognizeResponse', + 'SpeakerDiarizationConfig', + 'SpeechContext', + 'SpeechRecognitionAlternative', + 'SpeechRecognitionResult', + 'StreamingRecognitionConfig', + 'StreamingRecognitionResult', + 'StreamingRecognizeRequest', + 'StreamingRecognizeResponse', + 'TranscriptOutputConfig', + 'WordInfo', + 'CreateCustomClassRequest', + 'CreatePhraseSetRequest', + 'DeleteCustomClassRequest', + 'DeletePhraseSetRequest', + 'GetCustomClassRequest', + 'GetPhraseSetRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'UpdateCustomClassRequest', + 'UpdatePhraseSetRequest', + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', +) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py new file mode 100644 index 00000000..15fdb9cb --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py @@ -0,0 +1,1190 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import duration_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'RecognizeRequest', + 'LongRunningRecognizeRequest', + 'TranscriptOutputConfig', + 'StreamingRecognizeRequest', + 'StreamingRecognitionConfig', + 'RecognitionConfig', + 'SpeakerDiarizationConfig', + 'RecognitionMetadata', + 'SpeechContext', + 'RecognitionAudio', + 'RecognizeResponse', + 'LongRunningRecognizeResponse', + 'LongRunningRecognizeMetadata', + 'StreamingRecognizeResponse', + 'StreamingRecognitionResult', + 'SpeechRecognitionResult', + 'SpeechRecognitionAlternative', + 'WordInfo', + }, +) + + +class RecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the ``Recognize`` + method. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be recognized. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + + +class LongRunningRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``LongRunningRecognize`` method. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): + Required. The audio data to be recognized. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Optional. Specifies an optional destination + for the recognition results. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + audio = proto.Field( + proto.MESSAGE, + number=2, + message='RecognitionAudio', + ) + output_config = proto.Field( + proto.MESSAGE, + number=4, + message='TranscriptOutputConfig', + ) + + +class TranscriptOutputConfig(proto.Message): + r"""Specifies an optional destination for the recognition + results. + + Attributes: + gcs_uri (str): + Specifies a Cloud Storage URI for the recognition results. + Must be specified in the format: + ``gs://bucket_name/object_name``, and the bucket must + already exist. + """ + + gcs_uri = proto.Field( + proto.STRING, + number=1, + oneof='output_type', + ) + + +class StreamingRecognizeRequest(proto.Message): + r"""The top-level message sent by the client for the + ``StreamingRecognize`` method. Multiple + ``StreamingRecognizeRequest`` messages are sent. The first message + must contain a ``streaming_config`` message and must not contain + ``audio_content``. All subsequent messages must contain + ``audio_content`` and must not contain a ``streaming_config`` + message. + + Attributes: + streaming_config (google.cloud.speech_v1p1beta1.types.StreamingRecognitionConfig): + Provides information to the recognizer that specifies how to + process the request. The first ``StreamingRecognizeRequest`` + message must contain a ``streaming_config`` message. + audio_content (bytes): + The audio data to be recognized. Sequential chunks of audio + data are sent in sequential ``StreamingRecognizeRequest`` + messages. The first ``StreamingRecognizeRequest`` message + must not contain ``audio_content`` data and all subsequent + ``StreamingRecognizeRequest`` messages must contain + ``audio_content`` data. The audio bytes must be encoded as + specified in ``RecognitionConfig``. Note: as with all bytes + fields, proto buffers use a pure binary representation (not + base64). See `content + limits `__. + """ + + streaming_config = proto.Field( + proto.MESSAGE, + number=1, + oneof='streaming_request', + message='StreamingRecognitionConfig', + ) + audio_content = proto.Field( + proto.BYTES, + number=2, + oneof='streaming_request', + ) + + +class StreamingRecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): + Required. Provides information to the + recognizer that specifies how to process the + request. + single_utterance (bool): + If ``false`` or omitted, the recognizer will perform + continuous recognition (continuing to wait for and process + audio even if the user pauses speaking) until the client + closes the input stream (gRPC API) or until the maximum time + limit has been reached. May return multiple + ``StreamingRecognitionResult``\ s with the ``is_final`` flag + set to ``true``. + + If ``true``, the recognizer will detect a single spoken + utterance. When it detects that the user has paused or + stopped speaking, it will return an + ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It + will return no more than one ``StreamingRecognitionResult`` + with the ``is_final`` flag set to ``true``. + + The ``single_utterance`` field can only be used with + specified models, otherwise an error is thrown. The + ``model`` field in [``RecognitionConfig``][] must be set to: + + - ``command_and_search`` + - ``phone_call`` AND additional field + ``useEnhanced``\ =\ ``true`` + - The ``model`` field is left undefined. In this case the + API auto-selects a model based on any other parameters + that you set in ``RecognitionConfig``. + interim_results (bool): + If ``true``, interim results (tentative hypotheses) may be + returned as they become available (these interim results are + indicated with the ``is_final=false`` flag). If ``false`` or + omitted, only ``is_final=true`` result(s) are returned. + """ + + config = proto.Field( + proto.MESSAGE, + number=1, + message='RecognitionConfig', + ) + single_utterance = proto.Field( + proto.BOOL, + number=2, + ) + interim_results = proto.Field( + proto.BOOL, + number=3, + ) + + +class RecognitionConfig(proto.Message): + r"""Provides information to the recognizer that specifies how to + process the request. + + Attributes: + encoding (google.cloud.speech_v1p1beta1.types.RecognitionConfig.AudioEncoding): + Encoding of audio data sent in all ``RecognitionAudio`` + messages. This field is optional for ``FLAC`` and ``WAV`` + audio files and required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. + sample_rate_hertz (int): + Sample rate in Hertz of the audio data sent in all + ``RecognitionAudio`` messages. Valid values are: 8000-48000. + 16000 is optimal. For best results, set the sampling rate of + the audio source to 16000 Hz. If that's not possible, use + the native sample rate of the audio source (instead of + re-sampling). This field is optional for FLAC and WAV audio + files, but is required for all other audio formats. For + details, see + [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. + audio_channel_count (int): + The number of channels in the input audio data. ONLY set + this for MULTI-CHANNEL recognition. Valid values for + LINEAR16 and FLAC are ``1``-``8``. Valid values for OGG_OPUS + are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and + SPEEX_WITH_HEADER_BYTE is only ``1``. If ``0`` or omitted, + defaults to one channel (mono). Note: We only recognize the + first channel by default. To perform independent recognition + on each channel set + ``enable_separate_recognition_per_channel`` to 'true'. + enable_separate_recognition_per_channel (bool): + This needs to be set to ``true`` explicitly and + ``audio_channel_count`` > 1 to get each channel recognized + separately. The recognition result will contain a + ``channel_tag`` field to state which channel that result + belongs to. If this is not true, we will only recognize the + first channel. The request is billed cumulatively for all + channels recognized: ``audio_channel_count`` multiplied by + the length of the audio. + language_code (str): + Required. The language of the supplied audio as a + `BCP-47 `__ + language tag. Example: "en-US". See `Language + Support `__ + for a list of the currently supported language codes. + alternative_language_codes (Sequence[str]): + A list of up to 3 additional + `BCP-47 `__ + language tags, listing possible alternative languages of the + supplied audio. See `Language + Support `__ + for a list of the currently supported language codes. If + alternative languages are listed, recognition result will + contain recognition in the most likely language detected + including the main language_code. The recognition result + will include the language tag of the language detected in + the audio. Note: This feature is only supported for Voice + Command and Voice Search use cases and performance may vary + for other use cases (e.g., phone call transcription). + max_alternatives (int): + Maximum number of recognition hypotheses to be returned. + Specifically, the maximum number of + ``SpeechRecognitionAlternative`` messages within each + ``SpeechRecognitionResult``. The server may return fewer + than ``max_alternatives``. Valid values are ``0``-``30``. A + value of ``0`` or ``1`` will return a maximum of one. If + omitted, will return a maximum of one. + profanity_filter (bool): + If set to ``true``, the server will attempt to filter out + profanities, replacing all but the initial character in each + filtered word with asterisks, e.g. "f***". If set to + ``false`` or omitted, profanities won't be filtered out. + adaptation (google.cloud.speech_v1p1beta1.types.SpeechAdaptation): + Speech adaptation configuration improves the accuracy of + speech recognition. When speech adaptation is set it + supersedes the ``speech_contexts`` field. For more + information, see the `speech + adaptation `__ + documentation. + speech_contexts (Sequence[google.cloud.speech_v1p1beta1.types.SpeechContext]): + Array of + [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. + A means to provide context to assist the speech recognition. + For more information, see `speech + adaptation `__. + enable_word_time_offsets (bool): + If ``true``, the top result includes a list of words and the + start and end time offsets (timestamps) for those words. If + ``false``, no word-level time offset information is + returned. The default is ``false``. + enable_word_confidence (bool): + If ``true``, the top result includes a list of words and the + confidence for those words. If ``false``, no word-level + confidence information is returned. The default is + ``false``. + enable_automatic_punctuation (bool): + If 'true', adds punctuation to recognition + result hypotheses. This feature is only + available in select languages. Setting this for + requests in other languages has no effect at + all. The default 'false' value does not add + punctuation to result hypotheses. + enable_spoken_punctuation (google.protobuf.wrappers_pb2.BoolValue): + The spoken punctuation behavior for the call If not set, + uses default behavior based on model of choice e.g. + command_and_search will enable spoken punctuation by default + If 'true', replaces spoken punctuation with the + corresponding symbols in the request. For example, "how are + you question mark" becomes "how are you?". See + https://cloud.google.com/speech-to-text/docs/spoken-punctuation + for support. If 'false', spoken punctuation is not replaced. + enable_spoken_emojis (google.protobuf.wrappers_pb2.BoolValue): + The spoken emoji behavior for the call + If not set, uses default behavior based on model + of choice If 'true', adds spoken emoji + formatting for the request. This will replace + spoken emojis with the corresponding Unicode + symbols in the final transcript. If 'false', + spoken emojis are not replaced. + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. Note: Use + diarization_config instead. + diarization_speaker_count (int): + If set, specifies the estimated number of speakers in the + conversation. Defaults to '2'. Ignored unless + enable_speaker_diarization is set to true. Note: Use + diarization_config instead. + diarization_config (google.cloud.speech_v1p1beta1.types.SpeakerDiarizationConfig): + Config to enable speaker diarization and set + additional parameters to make diarization better + suited for your application. Note: When this is + enabled, we send all the words from the + beginning of the audio for the top alternative + in every consecutive STREAMING responses. This + is done in order to improve our speaker tags as + our models learn to identify the speakers in the + conversation over time. For non-streaming + requests, the diarization results will be + provided only in the top alternative of the + FINAL SpeechRecognitionResult. + metadata (google.cloud.speech_v1p1beta1.types.RecognitionMetadata): + Metadata regarding this request. + model (str): + Which model to select for the given request. Select the + model best suited to your domain to get best results. If a + model is not explicitly specified, then we auto-select a + model based on the parameters in the RecognitionConfig. + + .. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
ModelDescription
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically + recorded at an 8khz sampling rate).
videoBest for audio that originated from video or includes multiple + speakers. Ideally the audio is recorded at a 16khz or greater + sampling rate. This is a premium model that costs more than the + standard rate.
defaultBest for audio that is not one of the specific audio models. + For example, long-form audio. Ideally the audio is high-fidelity, + recorded at a 16khz or greater sampling rate.
+ use_enhanced (bool): + Set to true to use an enhanced model for speech recognition. + If ``use_enhanced`` is set to true and the ``model`` field + is not set, then an appropriate enhanced model is chosen if + an enhanced model exists for the audio. + + If ``use_enhanced`` is true and an enhanced version of the + specified model does not exist, then the speech is + recognized using the standard version of the specified + model. + """ + class AudioEncoding(proto.Enum): + r"""The encoding of the audio data sent in the request. + + All encodings support only 1 channel (mono) audio, unless the + ``audio_channel_count`` and + ``enable_separate_recognition_per_channel`` fields are set. + + For best results, the audio source should be captured and + transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). + The accuracy of the speech recognition can be reduced if lossy + codecs are used to capture or transmit audio, particularly if + background noise is present. Lossy codecs include ``MULAW``, + ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, + ``MP3``. + + The ``FLAC`` and ``WAV`` audio file formats include a header that + describes the included audio content. You can request recognition + for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` + encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in + your request, you do not need to specify an ``AudioEncoding``; the + audio encoding format is determined from the file header. If you + specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` + audio, the encoding configuration must match the encoding described + in the audio header; otherwise the request returns an + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] + error code. + """ + ENCODING_UNSPECIFIED = 0 + LINEAR16 = 1 + FLAC = 2 + MULAW = 3 + AMR = 4 + AMR_WB = 5 + OGG_OPUS = 6 + SPEEX_WITH_HEADER_BYTE = 7 + MP3 = 8 + WEBM_OPUS = 9 + + encoding = proto.Field( + proto.ENUM, + number=1, + enum=AudioEncoding, + ) + sample_rate_hertz = proto.Field( + proto.INT32, + number=2, + ) + audio_channel_count = proto.Field( + proto.INT32, + number=7, + ) + enable_separate_recognition_per_channel = proto.Field( + proto.BOOL, + number=12, + ) + language_code = proto.Field( + proto.STRING, + number=3, + ) + alternative_language_codes = proto.RepeatedField( + proto.STRING, + number=18, + ) + max_alternatives = proto.Field( + proto.INT32, + number=4, + ) + profanity_filter = proto.Field( + proto.BOOL, + number=5, + ) + adaptation = proto.Field( + proto.MESSAGE, + number=20, + message=resource.SpeechAdaptation, + ) + speech_contexts = proto.RepeatedField( + proto.MESSAGE, + number=6, + message='SpeechContext', + ) + enable_word_time_offsets = proto.Field( + proto.BOOL, + number=8, + ) + enable_word_confidence = proto.Field( + proto.BOOL, + number=15, + ) + enable_automatic_punctuation = proto.Field( + proto.BOOL, + number=11, + ) + enable_spoken_punctuation = proto.Field( + proto.MESSAGE, + number=22, + message=wrappers_pb2.BoolValue, + ) + enable_spoken_emojis = proto.Field( + proto.MESSAGE, + number=23, + message=wrappers_pb2.BoolValue, + ) + enable_speaker_diarization = proto.Field( + proto.BOOL, + number=16, + ) + diarization_speaker_count = proto.Field( + proto.INT32, + number=17, + ) + diarization_config = proto.Field( + proto.MESSAGE, + number=19, + message='SpeakerDiarizationConfig', + ) + metadata = proto.Field( + proto.MESSAGE, + number=9, + message='RecognitionMetadata', + ) + model = proto.Field( + proto.STRING, + number=13, + ) + use_enhanced = proto.Field( + proto.BOOL, + number=14, + ) + + +class SpeakerDiarizationConfig(proto.Message): + r"""Config to enable speaker diarization. + Attributes: + enable_speaker_diarization (bool): + If 'true', enables speaker detection for each recognized + word in the top alternative of the recognition result using + a speaker_tag provided in the WordInfo. + min_speaker_count (int): + Minimum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 2. + max_speaker_count (int): + Maximum number of speakers in the + conversation. This range gives you more + flexibility by allowing the system to + automatically determine the correct number of + speakers. If not set, the default value is 6. + speaker_tag (int): + Output only. Unused. + """ + + enable_speaker_diarization = proto.Field( + proto.BOOL, + number=1, + ) + min_speaker_count = proto.Field( + proto.INT32, + number=2, + ) + max_speaker_count = proto.Field( + proto.INT32, + number=3, + ) + speaker_tag = proto.Field( + proto.INT32, + number=5, + ) + + +class RecognitionMetadata(proto.Message): + r"""Description of audio data to be recognized. + Attributes: + interaction_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.InteractionType): + The use case most closely describing the + audio content to be recognized. + industry_naics_code_of_audio (int): + The industry vertical to which this speech + recognition request most closely applies. This + is most indicative of the topics contained in + the audio. Use the 6-digit NAICS code to + identify the industry vertical - see + https://www.naics.com/search/. + microphone_distance (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.MicrophoneDistance): + The audio type that most closely describes + the audio being recognized. + original_media_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.OriginalMediaType): + The original media the speech was recorded + on. + recording_device_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.RecordingDeviceType): + The type of device the speech was recorded + with. + recording_device_name (str): + The device used to make the recording. + Examples 'Nexus 5X' or 'Polycom SoundStation IP + 6000' or 'POTS' or 'VoIP' or 'Cardioid + Microphone'. + original_mime_type (str): + Mime type of the original audio file. For example + ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, + ``audio/3gpp``. A list of possible audio mime types is + maintained at + http://www.iana.org/assignments/media-types/media-types.xhtml#audio + obfuscated_id (int): + Obfuscated (privacy-protected) ID of the + user, to identify number of unique users using + the service. + audio_topic (str): + Description of the content. Eg. "Recordings + of federal supreme court hearings from 2012". + """ + class InteractionType(proto.Enum): + r"""Use case categories that the audio recognition request can be + described by. + """ + INTERACTION_TYPE_UNSPECIFIED = 0 + DISCUSSION = 1 + PRESENTATION = 2 + PHONE_CALL = 3 + VOICEMAIL = 4 + PROFESSIONALLY_PRODUCED = 5 + VOICE_SEARCH = 6 + VOICE_COMMAND = 7 + DICTATION = 8 + + class MicrophoneDistance(proto.Enum): + r"""Enumerates the types of capture settings describing an audio + file. + """ + MICROPHONE_DISTANCE_UNSPECIFIED = 0 + NEARFIELD = 1 + MIDFIELD = 2 + FARFIELD = 3 + + class OriginalMediaType(proto.Enum): + r"""The original media the speech was recorded on.""" + ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 + AUDIO = 1 + VIDEO = 2 + + class RecordingDeviceType(proto.Enum): + r"""The type of device the speech was recorded with.""" + RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 + SMARTPHONE = 1 + PC = 2 + PHONE_LINE = 3 + VEHICLE = 4 + OTHER_OUTDOOR_DEVICE = 5 + OTHER_INDOOR_DEVICE = 6 + + interaction_type = proto.Field( + proto.ENUM, + number=1, + enum=InteractionType, + ) + industry_naics_code_of_audio = proto.Field( + proto.UINT32, + number=3, + ) + microphone_distance = proto.Field( + proto.ENUM, + number=4, + enum=MicrophoneDistance, + ) + original_media_type = proto.Field( + proto.ENUM, + number=5, + enum=OriginalMediaType, + ) + recording_device_type = proto.Field( + proto.ENUM, + number=6, + enum=RecordingDeviceType, + ) + recording_device_name = proto.Field( + proto.STRING, + number=7, + ) + original_mime_type = proto.Field( + proto.STRING, + number=8, + ) + obfuscated_id = proto.Field( + proto.INT64, + number=9, + ) + audio_topic = proto.Field( + proto.STRING, + number=10, + ) + + +class SpeechContext(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + phrases (Sequence[str]): + A list of strings containing words and phrases "hints" so + that the speech recognition is more likely to recognize + them. This can be used to improve the accuracy for specific + words and phrases, for example, if specific commands are + typically spoken by the user. This can also be used to add + additional words to the vocabulary of the recognizer. See + `usage + limits `__. + + List items can also be set to classes for groups of words + that represent common concepts that occur in natural + language. For example, rather than providing phrase hints + for every month of the year, using the $MONTH class improves + the likelihood of correctly transcribing audio that includes + months. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. + """ + + phrases = proto.RepeatedField( + proto.STRING, + number=1, + ) + boost = proto.Field( + proto.FLOAT, + number=4, + ) + + +class RecognitionAudio(proto.Message): + r"""Contains audio data in the encoding specified in the + ``RecognitionConfig``. Either ``content`` or ``uri`` must be + supplied. Supplying both or neither returns + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. + See `content + limits `__. + + Attributes: + content (bytes): + The audio data bytes encoded as specified in + ``RecognitionConfig``. Note: as with all bytes fields, proto + buffers use a pure binary representation, whereas JSON + representations use base64. + uri (str): + URI that points to a file that contains audio data bytes as + specified in ``RecognitionConfig``. The file must not be + compressed (for example, gzip). Currently, only Google Cloud + Storage URIs are supported, which must be specified in the + following format: ``gs://bucket_name/object_name`` (other + URI formats return + [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). + For more information, see `Request + URIs `__. + """ + + content = proto.Field( + proto.BYTES, + number=1, + oneof='audio_source', + ) + uri = proto.Field( + proto.STRING, + number=2, + oneof='audio_source', + ) + + +class RecognizeResponse(proto.Message): + r"""The only message returned to the client by the ``Recognize`` method. + It contains the result as zero or more sequential + ``SpeechRecognitionResult`` messages. + + Attributes: + results (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + """ + + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + + +class LongRunningRecognizeResponse(proto.Message): + r"""The only message returned to the client by the + ``LongRunningRecognize`` method. It contains the result as zero or + more sequential ``SpeechRecognitionResult`` messages. It is included + in the ``result.response`` field of the ``Operation`` returned by + the ``GetOperation`` call of the ``google::longrunning::Operations`` + service. + + Attributes: + results (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): + Sequential list of transcription results + corresponding to sequential portions of audio. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Original output config if present in the + request. + output_error (google.rpc.status_pb2.Status): + If the transcript output fails this field + contains the relevant error. + """ + + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='SpeechRecognitionResult', + ) + output_config = proto.Field( + proto.MESSAGE, + number=6, + message='TranscriptOutputConfig', + ) + output_error = proto.Field( + proto.MESSAGE, + number=7, + message=status_pb2.Status, + ) + + +class LongRunningRecognizeMetadata(proto.Message): + r"""Describes the progress of a long-running ``LongRunningRecognize`` + call. It is included in the ``metadata`` field of the ``Operation`` + returned by the ``GetOperation`` call of the + ``google::longrunning::Operations`` service. + + Attributes: + progress_percent (int): + Approximate percentage of audio processed + thus far. Guaranteed to be 100 when the audio is + fully processed and the results are available. + start_time (google.protobuf.timestamp_pb2.Timestamp): + Time when the request was received. + last_update_time (google.protobuf.timestamp_pb2.Timestamp): + Time of the most recent processing update. + uri (str): + Output only. The URI of the audio file being + transcribed. Empty if the audio was sent as byte + content. + output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): + Output only. A copy of the + TranscriptOutputConfig if it was set in the + request. + """ + + progress_percent = proto.Field( + proto.INT32, + number=1, + ) + start_time = proto.Field( + proto.MESSAGE, + number=2, + message=timestamp_pb2.Timestamp, + ) + last_update_time = proto.Field( + proto.MESSAGE, + number=3, + message=timestamp_pb2.Timestamp, + ) + uri = proto.Field( + proto.STRING, + number=4, + ) + output_config = proto.Field( + proto.MESSAGE, + number=5, + message='TranscriptOutputConfig', + ) + + +class StreamingRecognizeResponse(proto.Message): + r"""``StreamingRecognizeResponse`` is the only message returned to the + client by ``StreamingRecognize``. A series of zero or more + ``StreamingRecognizeResponse`` messages are streamed back to the + client. If there is no recognizable audio, and ``single_utterance`` + is set to false, then no messages are streamed back to the client. + + Here's an example of a series of ``StreamingRecognizeResponse``\ s + that might be returned while processing audio: + + 1. results { alternatives { transcript: "tube" } stability: 0.01 } + + 2. results { alternatives { transcript: "to be a" } stability: 0.01 + } + + 3. results { alternatives { transcript: "to be" } stability: 0.9 } + results { alternatives { transcript: " or not to be" } stability: + 0.01 } + + 4. results { alternatives { transcript: "to be or not to be" + confidence: 0.92 } alternatives { transcript: "to bee or not to + bee" } is_final: true } + + 5. results { alternatives { transcript: " that's" } stability: 0.01 + } + + 6. results { alternatives { transcript: " that is" } stability: 0.9 + } results { alternatives { transcript: " the question" } + stability: 0.01 } + + 7. results { alternatives { transcript: " that is the question" + confidence: 0.98 } alternatives { transcript: " that was the + question" } is_final: true } + + Notes: + + - Only two of the above responses #4 and #7 contain final results; + they are indicated by ``is_final: true``. Concatenating these + together generates the full transcript: "to be or not to be that + is the question". + + - The others contain interim ``results``. #3 and #6 contain two + interim ``results``: the first portion has a high stability and + is less likely to change; the second portion has a low stability + and is very likely to change. A UI designer might choose to show + only high stability ``results``. + + - The specific ``stability`` and ``confidence`` values shown above + are only for illustrative purposes. Actual values may vary. + + - In each response, only one of these fields will be set: + ``error``, ``speech_event_type``, or one or more (repeated) + ``results``. + + Attributes: + error (google.rpc.status_pb2.Status): + If set, returns a [google.rpc.Status][google.rpc.Status] + message that specifies the error for the operation. + results (Sequence[google.cloud.speech_v1p1beta1.types.StreamingRecognitionResult]): + This repeated list contains zero or more results that + correspond to consecutive portions of the audio currently + being processed. It contains zero or one ``is_final=true`` + result (the newly settled portion), followed by zero or more + ``is_final=false`` results (the interim results). + speech_event_type (google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse.SpeechEventType): + Indicates the type of speech event. + """ + class SpeechEventType(proto.Enum): + r"""Indicates the type of speech event.""" + SPEECH_EVENT_UNSPECIFIED = 0 + END_OF_SINGLE_UTTERANCE = 1 + + error = proto.Field( + proto.MESSAGE, + number=1, + message=status_pb2.Status, + ) + results = proto.RepeatedField( + proto.MESSAGE, + number=2, + message='StreamingRecognitionResult', + ) + speech_event_type = proto.Field( + proto.ENUM, + number=4, + enum=SpeechEventType, + ) + + +class StreamingRecognitionResult(proto.Message): + r"""A streaming speech recognition result corresponding to a + portion of the audio that is currently being processed. + + Attributes: + alternatives (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + is_final (bool): + If ``false``, this ``StreamingRecognitionResult`` represents + an interim result that may change. If ``true``, this is the + final time the speech service will return this particular + ``StreamingRecognitionResult``, the recognizer will not + return any further hypotheses for this portion of the + transcript and corresponding audio. + stability (float): + An estimate of the likelihood that the recognizer will not + change its guess about this interim result. Values range + from 0.0 (completely unstable) to 1.0 (completely stable). + This field is only provided for interim results + (``is_final=false``). The default of 0.0 is a sentinel value + indicating ``stability`` was not set. + result_end_time (google.protobuf.duration_pb2.Duration): + Time offset of the end of this result + relative to the beginning of the audio. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + is_final = proto.Field( + proto.BOOL, + number=2, + ) + stability = proto.Field( + proto.FLOAT, + number=3, + ) + result_end_time = proto.Field( + proto.MESSAGE, + number=4, + message=duration_pb2.Duration, + ) + channel_tag = proto.Field( + proto.INT32, + number=5, + ) + language_code = proto.Field( + proto.STRING, + number=6, + ) + + +class SpeechRecognitionResult(proto.Message): + r"""A speech recognition result corresponding to a portion of the + audio. + + Attributes: + alternatives (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): + May contain one or more recognition hypotheses (up to the + maximum specified in ``max_alternatives``). These + alternatives are ordered in terms of accuracy, with the top + (first) alternative being the most probable, as ranked by + the recognizer. + channel_tag (int): + For multi-channel audio, this is the channel number + corresponding to the recognized result for the audio from + that channel. For audio_channel_count = N, its output values + can range from '1' to 'N'. + language_code (str): + Output only. The + `BCP-47 `__ + language tag of the language in this result. This language + code was detected to have the most likelihood of being + spoken in the audio. + """ + + alternatives = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='SpeechRecognitionAlternative', + ) + channel_tag = proto.Field( + proto.INT32, + number=2, + ) + language_code = proto.Field( + proto.STRING, + number=5, + ) + + +class SpeechRecognitionAlternative(proto.Message): + r"""Alternative hypotheses (a.k.a. n-best list). + Attributes: + transcript (str): + Transcript text representing the words that + the user spoke. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + words (Sequence[google.cloud.speech_v1p1beta1.types.WordInfo]): + A list of word-specific information for each recognized + word. Note: When ``enable_speaker_diarization`` is true, you + will see all the words from the beginning of the audio. + """ + + transcript = proto.Field( + proto.STRING, + number=1, + ) + confidence = proto.Field( + proto.FLOAT, + number=2, + ) + words = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='WordInfo', + ) + + +class WordInfo(proto.Message): + r"""Word-specific information for recognized words. + Attributes: + start_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the start of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + end_time (google.protobuf.duration_pb2.Duration): + Time offset relative to the beginning of the audio, and + corresponding to the end of the spoken word. This field is + only set if ``enable_word_time_offsets=true`` and only in + the top hypothesis. This is an experimental feature and the + accuracy of the time offset can vary. + word (str): + The word corresponding to this set of + information. + confidence (float): + The confidence estimate between 0.0 and 1.0. A higher number + indicates an estimated greater likelihood that the + recognized words are correct. This field is set only for the + top alternative of a non-streaming result or, of a streaming + result where ``is_final=true``. This field is not guaranteed + to be accurate and users should not rely on it to be always + provided. The default of 0.0 is a sentinel value indicating + ``confidence`` was not set. + speaker_tag (int): + Output only. A distinct integer value is assigned for every + speaker within the audio. This field specifies which one of + those speakers was detected to have spoken this word. Value + ranges from '1' to diarization_speaker_count. speaker_tag is + set if enable_speaker_diarization = 'true' and only in the + top alternative. + """ + + start_time = proto.Field( + proto.MESSAGE, + number=1, + message=duration_pb2.Duration, + ) + end_time = proto.Field( + proto.MESSAGE, + number=2, + message=duration_pb2.Duration, + ) + word = proto.Field( + proto.STRING, + number=3, + ) + confidence = proto.Field( + proto.FLOAT, + number=4, + ) + speaker_tag = proto.Field( + proto.INT32, + number=5, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py new file mode 100644 index 00000000..5c0345b6 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py @@ -0,0 +1,335 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + +from google.cloud.speech_v1p1beta1.types import resource +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'CreatePhraseSetRequest', + 'UpdatePhraseSetRequest', + 'GetPhraseSetRequest', + 'ListPhraseSetRequest', + 'ListPhraseSetResponse', + 'DeletePhraseSetRequest', + 'CreateCustomClassRequest', + 'UpdateCustomClassRequest', + 'GetCustomClassRequest', + 'ListCustomClassesRequest', + 'ListCustomClassesResponse', + 'DeleteCustomClassRequest', + }, +) + + +class CreatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``CreatePhraseSet`` method. + Attributes: + parent (str): + Required. The parent resource where this phrase set will be + created. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets + phrase_set_id (str): + The ID to use for the phrase set, which will become the + final component of the phrase set's resource name. + + This value should be 4-63 characters, and valid characters + are /[a-z][0-9]-/. + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to create. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + phrase_set_id = proto.Field( + proto.STRING, + number=2, + ) + phrase_set = proto.Field( + proto.MESSAGE, + number=3, + message=resource.PhraseSet, + ) + + +class UpdatePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``UpdatePhraseSet`` method. + Attributes: + phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): + Required. The phrase set to update. + + The phrase set's ``name`` field is used to identify the set + to be updated. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + phrase_set = proto.Field( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``GetPhraseSet`` method. + Attributes: + name (str): + Required. The name of the phrase set to retrieve. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class ListPhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``ListPhraseSet`` method. + Attributes: + parent (str): + Required. The parent, which owns this + collection of phrase set. Format: + projects/{project}/locations/{location} + page_size (int): + The maximum number of phrase sets to return. + The service may return fewer than this value. If + unspecified, at most 50 phrase sets will be + returned. The maximum value is 1000; values + above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListPhraseSet`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListPhraseSet`` must match the call that provided the page + token. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListPhraseSetResponse(proto.Message): + r"""Message returned to the client by the ``ListPhraseSet`` method. + Attributes: + phrase_sets (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): + The phrase set. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + phrase_sets = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.PhraseSet, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class DeletePhraseSetRequest(proto.Message): + r"""Message sent by the client for the ``DeletePhraseSet`` method. + Attributes: + name (str): + Required. The name of the phrase set to delete. Format: + {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``CreateCustomClass`` method. + Attributes: + parent (str): + Required. The parent resource where this custom class will + be created. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + custom_class_id (str): + The ID to use for the custom class, which will become the + final component of the custom class' resource name. + + This value should be 4-63 characters, and valid characters + are /[a-z][0-9]-/. + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to create. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id = proto.Field( + proto.STRING, + number=2, + ) + custom_class = proto.Field( + proto.MESSAGE, + number=3, + message=resource.CustomClass, + ) + + +class UpdateCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``UpdateCustomClass`` method. + Attributes: + custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): + Required. The custom class to update. + + The custom class's ``name`` field is used to identify the + custom class to be updated. Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + update_mask (google.protobuf.field_mask_pb2.FieldMask): + The list of fields to be updated. + """ + + custom_class = proto.Field( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + update_mask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class GetCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``GetCustomClass`` method. + Attributes: + name (str): + Required. The name of the custom class to retrieve. Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +class ListCustomClassesRequest(proto.Message): + r"""Message sent by the client for the ``ListCustomClasses`` method. + Attributes: + parent (str): + Required. The parent, which owns this collection of custom + classes. Format: + {api_version}/projects/{project}/locations/{location}/customClasses + page_size (int): + The maximum number of custom classes to + return. The service may return fewer than this + value. If unspecified, at most 50 custom classes + will be returned. The maximum value is 1000; + values above 1000 will be coerced to 1000. + page_token (str): + A page token, received from a previous ``ListCustomClass`` + call. Provide this to retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListCustomClass`` must match the call that provided the + page token. + """ + + parent = proto.Field( + proto.STRING, + number=1, + ) + page_size = proto.Field( + proto.INT32, + number=2, + ) + page_token = proto.Field( + proto.STRING, + number=3, + ) + + +class ListCustomClassesResponse(proto.Message): + r"""Message returned to the client by the ``ListCustomClasses`` method. + Attributes: + custom_classes (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass]): + The custom classes. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + custom_classes = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=resource.CustomClass, + ) + next_page_token = proto.Field( + proto.STRING, + number=2, + ) + + +class DeleteCustomClassRequest(proto.Message): + r"""Message sent by the client for the ``DeleteCustomClass`` method. + Attributes: + name (str): + Required. The name of the custom class to delete. Format: + {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py new file mode 100644 index 00000000..9dfd5b50 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py @@ -0,0 +1,195 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.speech.v1p1beta1', + manifest={ + 'CustomClass', + 'PhraseSet', + 'SpeechAdaptation', + }, +) + + +class CustomClass(proto.Message): + r"""A set of words or phrases that represents a common concept + likely to appear in your audio, for example a list of passenger + ship names. CustomClass items can be substituted into + placeholders that you set in PhraseSet phrases. + + Attributes: + name (str): + The resource name of the custom class. + custom_class_id (str): + If this custom class is a resource, the custom_class_id is + the resource id of the CustomClass. Case sensitive. + items (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass.ClassItem]): + A collection of class items. + """ + + class ClassItem(proto.Message): + r"""An item of the class. + Attributes: + value (str): + The class item's value. + """ + + value = proto.Field( + proto.STRING, + number=1, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + custom_class_id = proto.Field( + proto.STRING, + number=2, + ) + items = proto.RepeatedField( + proto.MESSAGE, + number=3, + message=ClassItem, + ) + + +class PhraseSet(proto.Message): + r"""Provides "hints" to the speech recognizer to favor specific + words and phrases in the results. + + Attributes: + name (str): + The resource name of the phrase set. + phrases (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet.Phrase]): + A list of word and phrases. + boost (float): + Hint Boost. Positive value will increase the probability + that a specific phrase will be recognized over other similar + sounding phrases. The higher the boost, the higher the + chance of false positive recognition as well. Negative boost + values would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 (exclusive) + and 20. We recommend using a binary search approach to + finding the optimal value for your use case. Speech + recognition will skip PhraseSets with a boost value of 0. + """ + + class Phrase(proto.Message): + r"""A phrases containing words and phrase "hints" so that the speech + recognition is more likely to recognize them. This can be used to + improve the accuracy for specific words and phrases, for example, if + specific commands are typically spoken by the user. This can also be + used to add additional words to the vocabulary of the recognizer. + See `usage + limits `__. + + List items can also include pre-built or custom classes containing + groups of words that represent common concepts that occur in natural + language. For example, rather than providing a phrase hint for every + month of the year (e.g. "i was born in january", "i was born in + febuary", ...), use the pre-built ``$MONTH`` class improves the + likelihood of correctly transcribing audio that includes months + (e.g. "i was born in $month"). To refer to pre-built classes, use + the class' symbol prepended with ``$`` e.g. ``$MONTH``. To refer to + custom classes that were defined inline in the request, set the + class's ``custom_class_id`` to a string unique to all class + resources and inline classes. Then use the class' id wrapped in + $\ ``{...}`` e.g. "${my-months}". To refer to custom classes + resources, use the class' id wrapped in ``${}`` (e.g. + ``${my-months}``). + + Attributes: + value (str): + The phrase itself. + boost (float): + Hint Boost. Overrides the boost set at the phrase set level. + Positive value will increase the probability that a specific + phrase will be recognized over other similar sounding + phrases. The higher the boost, the higher the chance of + false positive recognition as well. Negative boost values + would correspond to anti-biasing. Anti-biasing is not + enabled, so negative boost will simply be ignored. Though + ``boost`` can accept a wide range of positive values, most + use cases are best served with values between 0 and 20. We + recommend using a binary search approach to finding the + optimal value for your use case. Speech recognition will + skip PhraseSets with a boost value of 0. + """ + + value = proto.Field( + proto.STRING, + number=1, + ) + boost = proto.Field( + proto.FLOAT, + number=2, + ) + + name = proto.Field( + proto.STRING, + number=1, + ) + phrases = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=Phrase, + ) + boost = proto.Field( + proto.FLOAT, + number=4, + ) + + +class SpeechAdaptation(proto.Message): + r"""Speech adaptation configuration. + Attributes: + phrase_sets (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): + A collection of phrase sets. To specify the hints inline, + leave the phrase set's ``name`` blank and fill in the rest + of its fields. Any phrase set can use any custom class. + phrase_set_references (Sequence[str]): + A collection of phrase set resource names to + use. + custom_classes (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass]): + A collection of custom classes. To specify the classes + inline, leave the class' ``name`` blank and fill in the rest + of its fields, giving it a unique ``custom_class_id``. Refer + to the inline defined class in phrase hints by its + ``custom_class_id``. + """ + + phrase_sets = proto.RepeatedField( + proto.MESSAGE, + number=1, + message='PhraseSet', + ) + phrase_set_references = proto.RepeatedField( + proto.STRING, + number=2, + ) + custom_classes = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='CustomClass', + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/mypy.ini b/owl-bot-staging/v1p1beta1/mypy.ini new file mode 100644 index 00000000..4505b485 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1p1beta1/noxfile.py b/owl-bot-staging/v1p1beta1/noxfile.py new file mode 100644 index 00000000..babeb777 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +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") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/speech_v1p1beta1/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.7') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + 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='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py b/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py new file mode 100644 index 00000000..4701246e --- /dev/null +++ b/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py @@ -0,0 +1,188 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +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 speechCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_custom_class': ('parent', 'custom_class', 'custom_class_id', ), + 'create_phrase_set': ('parent', 'phrase_set', 'phrase_set_id', ), + 'delete_custom_class': ('name', ), + 'delete_phrase_set': ('name', ), + 'get_custom_class': ('name', ), + 'get_phrase_set': ('name', ), + 'list_custom_classes': ('parent', 'page_size', 'page_token', ), + 'list_phrase_set': ('parent', 'page_size', 'page_token', ), + 'long_running_recognize': ('config', 'audio', 'output_config', ), + 'recognize': ('config', 'audio', ), + 'streaming_recognize': ('streaming_config', 'audio_content', ), + 'update_custom_class': ('custom_class', 'update_mask', ), + 'update_phrase_set': ('phrase_set', 'update_mask', ), + } + + 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: not a.keyword.value 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=speechCallTransformer(), +): + """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 speech 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/v1p1beta1/setup.py b/owl-bot-staging/v1p1beta1/setup.py new file mode 100644 index 00000000..1fe40131 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/setup.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +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() + +setuptools.setup( + name='google-cloud-speech', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + 'packaging >= 14.3', ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1p1beta1/tests/__init__.py b/owl-bot-staging/v1p1beta1/tests/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1p1beta1/tests/unit/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py new file mode 100644 index 00000000..b54a5fcc --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py new file mode 100644 index 00000000..44014720 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py @@ -0,0 +1,3689 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationAsyncClient +from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationClient +from google.cloud.speech_v1p1beta1.services.adaptation import pagers +from google.cloud.speech_v1p1beta1.services.adaptation import transports +from google.cloud.speech_v1p1beta1.services.adaptation.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation +from google.cloud.speech_v1p1beta1.types import resource +from google.oauth2 import service_account +from google.protobuf import field_mask_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +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 AdaptationClient._get_default_mtls_endpoint(None) is None + assert AdaptationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert AdaptationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + AdaptationClient, + AdaptationAsyncClient, +]) +def test_adaptation_client_from_service_account_info(client_class): + 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) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + AdaptationClient, + AdaptationAsyncClient, +]) +def test_adaptation_client_service_account_always_use_jwt(client_class): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + +@pytest.mark.parametrize("client_class", [ + AdaptationClient, + AdaptationAsyncClient, +]) +def test_adaptation_client_from_service_account_file(client_class): + 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") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_adaptation_client_get_transport_class(): + transport = AdaptationClient.get_transport_class() + available_transports = [ + transports.AdaptationGrpcTransport, + ] + assert transport in available_transports + + transport = AdaptationClient.get_transport_class("grpc") + assert transport == transports.AdaptationGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +def test_adaptation_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(AdaptationClient, '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(AdaptationClient, '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(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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + # 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() + + # 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() + + # 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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "true"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "false"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) +@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_adaptation_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) + + 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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_adaptation_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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), + (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_adaptation_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + 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, + ) + + +def test_adaptation_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = AdaptationClient( + 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, + ) + + +def test_create_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_create_phrase_set_from_dict(): + test_create_phrase_set(request_type=dict) + + +def test_create_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.create_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_create_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.create_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_create_phrase_set_async_from_dict(): + await test_create_phrase_set_async(request_type=dict) + + +def test_create_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.create_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreatePhraseSetRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.create_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].phrase_set == resource.PhraseSet(name='name_value') + assert args[0].phrase_set_id == 'phrase_set_id_value' + + +def test_create_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_phrase_set( + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].phrase_set == resource.PhraseSet(name='name_value') + assert args[0].phrase_set_id == 'phrase_set_id_value' + + +@pytest.mark.asyncio +async def test_create_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.CreatePhraseSetRequest(), + parent='parent_value', + phrase_set=resource.PhraseSet(name='name_value'), + phrase_set_id='phrase_set_id_value', + ) + + +def test_get_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_get_phrase_set_from_dict(): + test_get_phrase_set(request_type=dict) + + +def test_get_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.get_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + +@pytest.mark.asyncio +async def test_get_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetPhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.get_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_get_phrase_set_async_from_dict(): + await test_get_phrase_set_async(request_type=dict) + + +def test_get_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.get_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetPhraseSetRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.get_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_phrase_set( + 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] + assert args[0].name == 'name_value' + + +def test_get_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_phrase_set( + 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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.GetPhraseSetRequest(), + name='name_value', + ) + + +def test_list_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + ) + response = client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_phrase_set_from_dict(): + test_list_phrase_set(request_type=dict) + + +def test_list_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.list_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + +@pytest.mark.asyncio +async def test_list_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListPhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListPhraseSetAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_phrase_set_async_from_dict(): + await test_list_phrase_set_async(request_type=dict) + + +def test_list_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + client.list_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListPhraseSetRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + await client.list_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_phrase_set( + 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] + assert args[0].parent == 'parent_value' + + +def test_list_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_phrase_set( + 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] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.ListPhraseSetRequest(), + parent='parent_value', + ) + + +def test_list_phrase_set_pager(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_phrase_set(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in results) + +def test_list_phrase_set_pages(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = list(client.list_phrase_set(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_phrase_set_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_phrase_set(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.PhraseSet) + for i in responses) + +@pytest.mark.asyncio +async def test_list_phrase_set_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_phrase_set), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + resource.PhraseSet(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListPhraseSetResponse( + phrase_sets=[ + resource.PhraseSet(), + resource.PhraseSet(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_phrase_set(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_update_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationClient( + 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.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet( + name='name_value', + boost=0.551, + ) + response = client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +def test_update_phrase_set_from_dict(): + test_update_phrase_set(request_type=dict) + + +def test_update_phrase_set_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 = AdaptationClient( + 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.update_phrase_set), + '__call__') as call: + client.update_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_update_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): + client = AdaptationAsyncClient( + 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.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( + name='name_value', + boost=0.551, + )) + response = await client.update_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.PhraseSet) + assert response.name == 'name_value' + assert math.isclose(response.boost, 0.551, rel_tol=1e-6) + + +@pytest.mark.asyncio +async def test_update_phrase_set_async_from_dict(): + await test_update_phrase_set_async(request_type=dict) + + +def test_update_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'phrase_set.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = resource.PhraseSet() + client.update_phrase_set(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', + 'phrase_set.name=phrase_set.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() + + request.phrase_set.name = 'phrase_set.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + await client.update_phrase_set(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', + 'phrase_set.name=phrase_set.name/value', + ) in kw['metadata'] + + +def test_update_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_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] + assert args[0].phrase_set == resource.PhraseSet(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_phrase_set_flattened_error(): + client = AdaptationClient( + 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.update_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.PhraseSet() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_phrase_set( + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].phrase_set == resource.PhraseSet(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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.update_phrase_set( + cloud_speech_adaptation.UpdatePhraseSetRequest(), + phrase_set=resource.PhraseSet(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_phrase_set_from_dict(): + test_delete_phrase_set(request_type=dict) + + +def test_delete_phrase_set_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 = AdaptationClient( + 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_phrase_set), + '__call__') as call: + client.delete_phrase_set() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): + client = AdaptationAsyncClient( + 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_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_phrase_set(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_phrase_set_async_from_dict(): + await test_delete_phrase_set_async(request_type=dict) + + +def test_delete_phrase_set_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = None + client.delete_phrase_set(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_phrase_set_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeletePhraseSetRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_phrase_set(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_phrase_set_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_phrase_set( + 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] + assert args[0].name == 'name_value' + + +def test_delete_phrase_set_flattened_error(): + client = AdaptationClient( + 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_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_phrase_set), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_phrase_set( + 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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_phrase_set_flattened_error_async(): + client = AdaptationAsyncClient( + 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_phrase_set( + cloud_speech_adaptation.DeletePhraseSetRequest(), + name='name_value', + ) + + +def test_create_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_from_dict(): + test_create_custom_class(request_type=dict) + + +def test_create_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.create_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + +@pytest.mark.asyncio +async def test_create_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreateCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.create_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_create_custom_class_async_from_dict(): + await test_create_custom_class_async(request_type=dict) + + +def test_create_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.create_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.CreateCustomClassRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.create_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].custom_class == resource.CustomClass(name='name_value') + assert args[0].custom_class_id == 'custom_class_id_value' + + +def test_create_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_custom_class( + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].parent == 'parent_value' + assert args[0].custom_class == resource.CustomClass(name='name_value') + assert args[0].custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_create_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.CreateCustomClassRequest(), + parent='parent_value', + custom_class=resource.CustomClass(name='name_value'), + custom_class_id='custom_class_id_value', + ) + + +def test_get_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_get_custom_class_from_dict(): + test_get_custom_class(request_type=dict) + + +def test_get_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.get_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + +@pytest.mark.asyncio +async def test_get_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.get_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_get_custom_class_async_from_dict(): + await test_get_custom_class_async(request_type=dict) + + +def test_get_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.get_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.GetCustomClassRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.get_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_custom_class( + 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] + assert args[0].name == 'name_value' + + +def test_get_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_custom_class( + 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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.GetCustomClassRequest(), + name='name_value', + ) + + +def test_list_custom_classes(transport: str = 'grpc', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationClient( + 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_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + ) + response = client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesPager) + assert response.next_page_token == 'next_page_token_value' + + +def test_list_custom_classes_from_dict(): + test_list_custom_classes(request_type=dict) + + +def test_list_custom_classes_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 = AdaptationClient( + 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_custom_classes), + '__call__') as call: + client.list_custom_classes() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + +@pytest.mark.asyncio +async def test_list_custom_classes_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListCustomClassesRequest): + client = AdaptationAsyncClient( + 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_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse( + next_page_token='next_page_token_value', + )) + response = await client.list_custom_classes(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListCustomClassesAsyncPager) + assert response.next_page_token == 'next_page_token_value' + + +@pytest.mark.asyncio +async def test_list_custom_classes_async_from_dict(): + await test_list_custom_classes_async(request_type=dict) + + +def test_list_custom_classes_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + client.list_custom_classes(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_custom_classes_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.ListCustomClassesRequest() + + request.parent = 'parent/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + await client.list_custom_classes(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_custom_classes_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_custom_classes( + 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] + assert args[0].parent == 'parent_value' + + +def test_list_custom_classes_flattened_error(): + client = AdaptationClient( + 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_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_custom_classes( + 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] + assert args[0].parent == 'parent_value' + + +@pytest.mark.asyncio +async def test_list_custom_classes_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_classes( + cloud_speech_adaptation.ListCustomClassesRequest(), + parent='parent_value', + ) + + +def test_list_custom_classes_pager(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + + metadata = () + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', ''), + )), + ) + pager = client.list_custom_classes(request={}) + + assert pager._metadata == metadata + + results = [i for i in pager] + assert len(results) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in results) + +def test_list_custom_classes_pages(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__') as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = list(client.list_custom_classes(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_custom_classes_async_pager(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_custom_classes(request={},) + assert async_pager.next_page_token == 'abc' + responses = [] + async for response in async_pager: + responses.append(response) + + assert len(responses) == 6 + assert all(isinstance(i, resource.CustomClass) + for i in responses) + +@pytest.mark.asyncio +async def test_list_custom_classes_async_pages(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_custom_classes), + '__call__', new_callable=mock.AsyncMock) as call: + # Set the response to a series of pages. + call.side_effect = ( + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + resource.CustomClass(), + ], + next_page_token='abc', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[], + next_page_token='def', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + ], + next_page_token='ghi', + ), + cloud_speech_adaptation.ListCustomClassesResponse( + custom_classes=[ + resource.CustomClass(), + resource.CustomClass(), + ], + ), + RuntimeError, + ) + pages = [] + async for page_ in (await client.list_custom_classes(request={})).pages: + pages.append(page_) + for page_, token in zip(pages, ['abc','def','ghi', '']): + assert page_.raw_page.next_page_token == token + +def test_update_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationClient( + 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.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + ) + response = client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +def test_update_custom_class_from_dict(): + test_update_custom_class(request_type=dict) + + +def test_update_custom_class_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 = AdaptationClient( + 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.update_custom_class), + '__call__') as call: + client.update_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + +@pytest.mark.asyncio +async def test_update_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): + client = AdaptationAsyncClient( + 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.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( + name='name_value', + custom_class_id='custom_class_id_value', + )) + response = await client.update_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, resource.CustomClass) + assert response.name == 'name_value' + assert response.custom_class_id == 'custom_class_id_value' + + +@pytest.mark.asyncio +async def test_update_custom_class_async_from_dict(): + await test_update_custom_class_async(request_type=dict) + + +def test_update_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'custom_class.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = resource.CustomClass() + client.update_custom_class(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', + 'custom_class.name=custom_class.name/value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.UpdateCustomClassRequest() + + request.custom_class.name = 'custom_class.name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + await client.update_custom_class(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', + 'custom_class.name=custom_class.name/value', + ) in kw['metadata'] + + +def test_update_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_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] + assert args[0].custom_class == resource.CustomClass(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +def test_update_custom_class_flattened_error(): + client = AdaptationClient( + 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.update_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = resource.CustomClass() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_custom_class( + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].custom_class == resource.CustomClass(name='name_value') + assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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.update_custom_class( + cloud_speech_adaptation.UpdateCustomClassRequest(), + custom_class=resource.CustomClass(name='name_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_delete_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_custom_class_from_dict(): + test_delete_custom_class(request_type=dict) + + +def test_delete_custom_class_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 = AdaptationClient( + 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_custom_class), + '__call__') as call: + client.delete_custom_class() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + +@pytest.mark.asyncio +async def test_delete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): + client = AdaptationAsyncClient( + 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_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_custom_class(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_custom_class_async_from_dict(): + await test_delete_custom_class_async(request_type=dict) + + +def test_delete_custom_class_field_headers(): + client = AdaptationClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = None + client.delete_custom_class(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_custom_class_field_headers_async(): + client = AdaptationAsyncClient( + 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 = cloud_speech_adaptation.DeleteCustomClassRequest() + + request.name = 'name/value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_custom_class(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_custom_class_flattened(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_custom_class( + 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] + assert args[0].name == 'name_value' + + +def test_delete_custom_class_flattened_error(): + client = AdaptationClient( + 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_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_async(): + client = AdaptationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_custom_class), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_custom_class( + 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] + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_custom_class_flattened_error_async(): + client = AdaptationAsyncClient( + 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_custom_class( + cloud_speech_adaptation.DeleteCustomClassRequest(), + name='name_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AdaptationClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AdaptationClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AdaptationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AdaptationGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AdaptationGrpcTransport, + ) + +def test_adaptation_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_adaptation_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.AdaptationTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_phrase_set', + 'get_phrase_set', + 'list_phrase_set', + 'update_phrase_set', + 'delete_phrase_set', + 'create_custom_class', + 'get_custom_class', + 'list_custom_classes', + 'update_custom_class', + 'delete_custom_class', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + +@requires_google_auth_gte_1_25_0 +def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport( + 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', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_adaptation_base_transport_with_credentials_file_old_google_auth(): + # 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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AdaptationTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_adaptation_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) + AdaptationClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_adaptation_auth_adc_old_google_auth(): + # 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) + AdaptationClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_adaptation_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',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AdaptationGrpcTransport, + transports.AdaptationGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_adaptation_transport_auth_adc_old_google_auth(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") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AdaptationGrpcTransport, grpc_helpers), + (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_adaptation_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( + "speech.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_adaptation_host_no_port(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + ) + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_adaptation_host_with_port(): + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + ) + assert client.transport._host == 'speech.googleapis.com:8000' + +def test_adaptation_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcTransport( + 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_adaptation_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AdaptationGrpcAsyncIOTransport( + 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) +def test_adaptation_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = AdaptationClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = AdaptationClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = AdaptationClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = AdaptationClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = AdaptationClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = AdaptationClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = AdaptationClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = AdaptationClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = AdaptationClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = AdaptationClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = AdaptationClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = AdaptationClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = AdaptationClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = AdaptationClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AdaptationClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + client = AdaptationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: + transport_class = AdaptationClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py new file mode 100644 index 00000000..df95bc95 --- /dev/null +++ b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py @@ -0,0 +1,1406 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import mock +import packaging.version + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +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_async # type: ignore +from google.api_core import operations_v1 +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.speech_v1p1beta1.services.speech import SpeechAsyncClient +from google.cloud.speech_v1p1beta1.services.speech import SpeechClient +from google.cloud.speech_v1p1beta1.services.speech import transports +from google.cloud.speech_v1p1beta1.services.speech.transports.base import _GOOGLE_AUTH_VERSION +from google.cloud.speech_v1p1beta1.types import cloud_speech +from google.cloud.speech_v1p1beta1.types import resource +from google.longrunning import operations_pb2 +from google.oauth2 import service_account +from google.protobuf import wrappers_pb2 # type: ignore +from google.rpc import status_pb2 # type: ignore +import google.auth + + +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases +# - Delete these pytest markers (Make the "greater than or equal to" tests the default). +requires_google_auth_lt_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), + reason="This test requires google-auth < 1.25.0", +) +requires_google_auth_gte_1_25_0 = pytest.mark.skipif( + packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), + reason="This test requires google-auth >= 1.25.0", +) + +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 SpeechClient._get_default_mtls_endpoint(None) is None + assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_from_service_account_info(client_class): + 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) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_service_account_always_use_jwt(client_class): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + +@pytest.mark.parametrize("client_class", [ + SpeechClient, + SpeechAsyncClient, +]) +def test_speech_client_from_service_account_file(client_class): + 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") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_speech_client_get_transport_class(): + transport = SpeechClient.get_transport_class() + available_transports = [ + transports.SpeechGrpcTransport, + ] + assert transport in available_transports + + transport = SpeechClient.get_transport_class("grpc") + assert transport == transports.SpeechGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +def test_speech_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(SpeechClient, '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(SpeechClient, '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(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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + # 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() + + # 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() + + # 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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) +@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_speech_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) + + 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, + ) + + # 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() + 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, + ) + + # 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() + 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, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_speech_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) + 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, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (SpeechClient, transports.SpeechGrpcTransport, "grpc"), + (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + 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, + ) + + +def test_speech_client_client_options_from_dict(): + with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = SpeechClient( + 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, + ) + + +def test_recognize(transport: str = 'grpc', request_type=cloud_speech.RecognizeRequest): + client = SpeechClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse( + ) + response = client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +def test_recognize_from_dict(): + test_recognize(request_type=dict) + + +def test_recognize_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 = SpeechClient( + 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.recognize), + '__call__') as call: + client.recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + +@pytest.mark.asyncio +async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): + client = SpeechAsyncClient( + 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.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( + )) + response = await client.recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.RecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, cloud_speech.RecognizeResponse) + + +@pytest.mark.asyncio +async def test_recognize_async_from_dict(): + await test_recognize_async(request_type=dict) + + +def test_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +def test_recognize_flattened_error(): + client = SpeechClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.asyncio +async def test_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = cloud_speech.RecognizeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +@pytest.mark.asyncio +async def test_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.recognize( + cloud_speech.RecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_long_running_recognize(transport: str = 'grpc', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = operations_pb2.Operation(name='operations/spam') + response = client.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +def test_long_running_recognize_from_dict(): + test_long_running_recognize(request_type=dict) + + +def test_long_running_recognize_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 = SpeechClient( + 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.long_running_recognize), + '__call__') as call: + client.long_running_recognize() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + +@pytest.mark.asyncio +async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): + client = SpeechAsyncClient( + 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.long_running_recognize), + '__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.long_running_recognize(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == cloud_speech.LongRunningRecognizeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, future.Future) + + +@pytest.mark.asyncio +async def test_long_running_recognize_async_from_dict(): + await test_long_running_recognize_async(request_type=dict) + + +def test_long_running_recognize_flattened(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__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.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +def test_long_running_recognize_flattened_error(): + client = SpeechClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_async(): + client = SpeechAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.long_running_recognize), + '__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.long_running_recognize( + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) + assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') + + +@pytest.mark.asyncio +async def test_long_running_recognize_flattened_error_async(): + client = SpeechAsyncClient( + 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.long_running_recognize( + cloud_speech.LongRunningRecognizeRequest(), + config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), + audio=cloud_speech.RecognitionAudio(content=b'content_blob'), + ) + + +def test_streaming_recognize(transport: str = 'grpc', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) + response = client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + for message in response: + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +def test_streaming_recognize_from_dict(): + test_streaming_recognize(request_type=dict) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): + client = SpeechAsyncClient( + 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() + requests = [request] + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.streaming_recognize), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) + call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) + response = await client.streaming_recognize(iter(requests)) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert next(args[0]) == request + + # Establish that the response is the type that we expect. + message = await response.read() + assert isinstance(message, cloud_speech.StreamingRecognizeResponse) + + +@pytest.mark.asyncio +async def test_streaming_recognize_async_from_dict(): + await test_streaming_recognize_async(request_type=dict) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = SpeechClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = SpeechClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.SpeechGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.SpeechGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.SpeechGrpcTransport, + ) + +def test_speech_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_speech_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.SpeechTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'recognize', + 'long_running_recognize', + 'streaming_recognize', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + # Additionally, the LRO client (a property) should + # also raise NotImplementedError + with pytest.raises(NotImplementedError): + transport.operations_client + + +@requires_google_auth_gte_1_25_0 +def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + 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', +), + quota_project_id="octopus", + ) + + +@requires_google_auth_lt_1_25_0 +def test_speech_base_transport_with_credentials_file_old_google_auth(): + # 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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + quota_project_id="octopus", + ) + + +def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.SpeechTransport() + adc.assert_called_once() + + +@requires_google_auth_gte_1_25_0 +def test_speech_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) + SpeechClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id=None, + ) + + +@requires_google_auth_lt_1_25_0 +def test_speech_auth_adc_old_google_auth(): + # 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) + SpeechClient() + adc.assert_called_once_with( + scopes=( 'https://www.googleapis.com/auth/cloud-platform',), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +@requires_google_auth_gte_1_25_0 +def test_speech_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',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.SpeechGrpcTransport, + transports.SpeechGrpcAsyncIOTransport, + ], +) +@requires_google_auth_lt_1_25_0 +def test_speech_transport_auth_adc_old_google_auth(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") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.SpeechGrpcTransport, grpc_helpers), + (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_speech_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( + "speech.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', +), + scopes=["1", "2"], + default_host="speech.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_speech_host_no_port(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), + ) + assert client.transport._host == 'speech.googleapis.com:443' + + +def test_speech_host_with_port(): + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), + ) + assert client.transport._host == 'speech.googleapis.com:8000' + +def test_speech_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcTransport( + 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_speech_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.SpeechGrpcAsyncIOTransport( + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) +def test_speech_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=( + 'https://www.googleapis.com/auth/cloud-platform', + ), + 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_speech_grpc_lro_client(): + client = SpeechClient( + 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_speech_grpc_lro_async_client(): + client = SpeechAsyncClient( + 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_custom_class_path(): + project = "squid" + location = "clam" + custom_class = "whelk" + expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) + actual = SpeechClient.custom_class_path(project, location, custom_class) + assert expected == actual + + +def test_parse_custom_class_path(): + expected = { + "project": "octopus", + "location": "oyster", + "custom_class": "nudibranch", + } + path = SpeechClient.custom_class_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_custom_class_path(path) + assert expected == actual + +def test_phrase_set_path(): + project = "cuttlefish" + location = "mussel" + phrase_set = "winkle" + expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) + actual = SpeechClient.phrase_set_path(project, location, phrase_set) + assert expected == actual + + +def test_parse_phrase_set_path(): + expected = { + "project": "nautilus", + "location": "scallop", + "phrase_set": "abalone", + } + path = SpeechClient.phrase_set_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_phrase_set_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = SpeechClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = SpeechClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = SpeechClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = SpeechClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = SpeechClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = SpeechClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = SpeechClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = SpeechClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = SpeechClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = SpeechClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = SpeechClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + client = SpeechClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: + transport_class = SpeechClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From d53727246f3a68eeeab54a4d436ba7780d661123 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Mon, 21 Jun 2021 23:59:42 +0000 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/master/packages/owl-bot/README.md --- .coveragerc | 1 - .../services/speech/transports/base.py | 40 +- .../services/speech/transports/grpc.py | 7 +- .../speech/transports/grpc_asyncio.py | 7 +- .../services/adaptation/transports/base.py | 40 +- .../services/adaptation/transports/grpc.py | 7 +- .../adaptation/transports/grpc_asyncio.py | 7 +- .../services/speech/transports/base.py | 40 +- .../services/speech/transports/grpc.py | 7 +- .../speech/transports/grpc_asyncio.py | 7 +- owl-bot-staging/v1/.coveragerc | 17 - owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/conf.py | 376 -- owl-bot-staging/v1/docs/index.rst | 7 - .../v1/docs/speech_v1/services.rst | 6 - owl-bot-staging/v1/docs/speech_v1/speech.rst | 6 - owl-bot-staging/v1/docs/speech_v1/types.rst | 7 - .../v1/google/cloud/speech/__init__.py | 57 - .../v1/google/cloud/speech/py.typed | 2 - .../v1/google/cloud/speech_v1/__init__.py | 58 - .../cloud/speech_v1/gapic_metadata.json | 53 - .../v1/google/cloud/speech_v1/py.typed | 2 - .../cloud/speech_v1/services/__init__.py | 15 - .../speech_v1/services/speech/__init__.py | 22 - .../speech_v1/services/speech/async_client.py | 464 --- .../cloud/speech_v1/services/speech/client.py | 624 --- .../services/speech/transports/__init__.py | 33 - .../services/speech/transports/base.py | 217 - .../services/speech/transports/grpc.py | 328 -- .../speech/transports/grpc_asyncio.py | 332 -- .../google/cloud/speech_v1/types/__init__.py | 54 - .../cloud/speech_v1/types/cloud_speech.py | 989 ----- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 132 - .../v1/scripts/fixup_speech_v1_keywords.py | 178 - owl-bot-staging/v1/setup.py | 53 - owl-bot-staging/v1/tests/__init__.py | 16 - owl-bot-staging/v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../v1/tests/unit/gapic/speech_v1/__init__.py | 16 - .../tests/unit/gapic/speech_v1/test_speech.py | 1362 ------ owl-bot-staging/v1p1beta1/.coveragerc | 17 - owl-bot-staging/v1p1beta1/MANIFEST.in | 2 - owl-bot-staging/v1p1beta1/README.rst | 49 - owl-bot-staging/v1p1beta1/docs/conf.py | 376 -- owl-bot-staging/v1p1beta1/docs/index.rst | 7 - .../docs/speech_v1p1beta1/adaptation.rst | 10 - .../docs/speech_v1p1beta1/services.rst | 7 - .../docs/speech_v1p1beta1/speech.rst | 6 - .../v1p1beta1/docs/speech_v1p1beta1/types.rst | 7 - .../v1p1beta1/google/cloud/speech/__init__.py | 93 - .../v1p1beta1/google/cloud/speech/py.typed | 2 - .../google/cloud/speech_v1p1beta1/__init__.py | 94 - .../speech_v1p1beta1/gapic_metadata.json | 167 - .../google/cloud/speech_v1p1beta1/py.typed | 2 - .../speech_v1p1beta1/services/__init__.py | 15 - .../services/adaptation/__init__.py | 22 - .../services/adaptation/async_client.py | 1015 ----- .../services/adaptation/client.py | 1211 ------ .../services/adaptation/pagers.py | 263 -- .../adaptation/transports/__init__.py | 33 - .../services/adaptation/transports/base.py | 296 -- .../services/adaptation/transports/grpc.py | 488 --- .../adaptation/transports/grpc_asyncio.py | 492 --- .../services/speech/__init__.py | 22 - .../services/speech/async_client.py | 468 --- .../services/speech/client.py | 646 --- .../services/speech/transports/__init__.py | 33 - .../services/speech/transports/base.py | 217 - .../services/speech/transports/grpc.py | 328 -- .../speech/transports/grpc_asyncio.py | 332 -- .../cloud/speech_v1p1beta1/types/__init__.py | 90 - .../speech_v1p1beta1/types/cloud_speech.py | 1190 ------ .../types/cloud_speech_adaptation.py | 335 -- .../cloud/speech_v1p1beta1/types/resource.py | 195 - owl-bot-staging/v1p1beta1/mypy.ini | 3 - owl-bot-staging/v1p1beta1/noxfile.py | 132 - .../fixup_speech_v1p1beta1_keywords.py | 188 - owl-bot-staging/v1p1beta1/setup.py | 53 - owl-bot-staging/v1p1beta1/tests/__init__.py | 16 - .../v1p1beta1/tests/unit/__init__.py | 16 - .../v1p1beta1/tests/unit/gapic/__init__.py | 16 - .../unit/gapic/speech_v1p1beta1/__init__.py | 16 - .../gapic/speech_v1p1beta1/test_adaptation.py | 3689 ----------------- .../gapic/speech_v1p1beta1/test_speech.py | 1406 ------- tests/unit/gapic/speech_v1/test_speech.py | 96 +- .../gapic/speech_v1p1beta1/test_adaptation.py | 100 +- .../gapic/speech_v1p1beta1/test_speech.py | 98 +- 89 files changed, 105 insertions(+), 19929 deletions(-) delete mode 100644 owl-bot-staging/v1/.coveragerc delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/docs/speech_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/speech_v1/speech.rst delete mode 100644 owl-bot-staging/v1/docs/speech_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/speech/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py delete mode 100644 owl-bot-staging/v1p1beta1/.coveragerc delete mode 100644 owl-bot-staging/v1p1beta1/MANIFEST.in delete mode 100644 owl-bot-staging/v1p1beta1/README.rst delete mode 100644 owl-bot-staging/v1p1beta1/docs/conf.py delete mode 100644 owl-bot-staging/v1p1beta1/docs/index.rst delete mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst delete mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst delete mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst delete mode 100644 owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py delete mode 100644 owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py delete mode 100644 owl-bot-staging/v1p1beta1/mypy.ini delete mode 100644 owl-bot-staging/v1p1beta1/noxfile.py delete mode 100644 owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py delete mode 100644 owl-bot-staging/v1p1beta1/setup.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py delete mode 100644 owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py diff --git a/.coveragerc b/.coveragerc index c101945d..f539ecf8 100644 --- a/.coveragerc +++ b/.coveragerc @@ -2,7 +2,6 @@ branch = True [report] -fail_under = 100 show_missing = True omit = google/cloud/speech/__init__.py diff --git a/google/cloud/speech_v1/services/speech/transports/base.py b/google/cloud/speech_v1/services/speech/transports/base.py index a2e0b4de..4fdc31c8 100644 --- a/google/cloud/speech_v1/services/speech/transports/base.py +++ b/google/cloud/speech_v1/services/speech/transports/base.py @@ -25,6 +25,7 @@ from google.api_core import retry as retries # type: ignore from google.api_core import operations_v1 # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore from google.cloud.speech_v1.types import cloud_speech from google.longrunning import operations_pb2 # type: ignore @@ -45,8 +46,6 @@ except pkg_resources.DistributionNotFound: # pragma: NO COVER _GOOGLE_AUTH_VERSION = None -_API_CORE_VERSION = google.api_core.__version__ - class SpeechTransport(abc.ABC): """Abstract transport class for Speech.""" @@ -64,6 +63,7 @@ def __init__( 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, **kwargs, ) -> None: """Instantiate the transport. @@ -87,6 +87,8 @@ def __init__( 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. """ # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: @@ -115,13 +117,20 @@ def __init__( **scopes_kwargs, quota_project_id=quota_project_id ) + # If the credentials is 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 - # TODO(busunkim): These two class methods are in the base transport + # TODO(busunkim): This method is in the base transport # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-api-core - # and google-auth are increased. + # should be deleted once the minimum required versions of google-auth is increased. # TODO: Remove this function once google-auth >= 1.25.0 is required @classmethod @@ -142,27 +151,6 @@ def _get_scopes_kwargs( return scopes_kwargs - # TODO: Remove this function once google-api-core >= 1.26.0 is required - @classmethod - def _get_self_signed_jwt_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Union[Optional[Sequence[str]], str]]: - """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" - - self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} - - if _API_CORE_VERSION and ( - packaging.version.parse(_API_CORE_VERSION) - >= packaging.version.parse("1.26.0") - ): - self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES - self_signed_jwt_kwargs["scopes"] = scopes - self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST - else: - self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES - - return self_signed_jwt_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { diff --git a/google/cloud/speech_v1/services/speech/transports/grpc.py b/google/cloud/speech_v1/services/speech/transports/grpc.py index 4c3d9b39..360533e2 100644 --- a/google/cloud/speech_v1/services/speech/transports/grpc.py +++ b/google/cloud/speech_v1/services/speech/transports/grpc.py @@ -152,6 +152,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: @@ -207,14 +208,14 @@ def create_channel( and ``credentials_file`` are passed. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) diff --git a/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py b/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py index a41c03f7..fc214af4 100644 --- a/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py +++ b/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py @@ -80,14 +80,14 @@ def create_channel( aio.Channel: A gRPC AsyncIO channel object. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers_async.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) @@ -198,6 +198,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: diff --git a/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py b/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py index a02a4ebb..8a1cbfb7 100644 --- a/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py +++ b/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py @@ -24,6 +24,7 @@ from google.api_core import gapic_v1 # type: ignore from google.api_core import retry as retries # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation from google.cloud.speech_v1p1beta1.types import resource @@ -45,8 +46,6 @@ except pkg_resources.DistributionNotFound: # pragma: NO COVER _GOOGLE_AUTH_VERSION = None -_API_CORE_VERSION = google.api_core.__version__ - class AdaptationTransport(abc.ABC): """Abstract transport class for Adaptation.""" @@ -64,6 +63,7 @@ def __init__( 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, **kwargs, ) -> None: """Instantiate the transport. @@ -87,6 +87,8 @@ def __init__( 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. """ # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: @@ -115,13 +117,20 @@ def __init__( **scopes_kwargs, quota_project_id=quota_project_id ) + # If the credentials is 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 - # TODO(busunkim): These two class methods are in the base transport + # TODO(busunkim): This method is in the base transport # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-api-core - # and google-auth are increased. + # should be deleted once the minimum required versions of google-auth is increased. # TODO: Remove this function once google-auth >= 1.25.0 is required @classmethod @@ -142,27 +151,6 @@ def _get_scopes_kwargs( return scopes_kwargs - # TODO: Remove this function once google-api-core >= 1.26.0 is required - @classmethod - def _get_self_signed_jwt_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Union[Optional[Sequence[str]], str]]: - """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" - - self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} - - if _API_CORE_VERSION and ( - packaging.version.parse(_API_CORE_VERSION) - >= packaging.version.parse("1.26.0") - ): - self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES - self_signed_jwt_kwargs["scopes"] = scopes - self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST - else: - self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES - - return self_signed_jwt_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { diff --git a/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py b/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py index eee794ae..352c4c85 100644 --- a/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py +++ b/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py @@ -151,6 +151,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: @@ -206,14 +207,14 @@ def create_channel( and ``credentials_file`` are passed. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) diff --git a/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py b/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py index 314ba063..df159f3c 100644 --- a/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py +++ b/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py @@ -80,14 +80,14 @@ def create_channel( aio.Channel: A gRPC AsyncIO channel object. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers_async.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) @@ -197,6 +197,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: diff --git a/google/cloud/speech_v1p1beta1/services/speech/transports/base.py b/google/cloud/speech_v1p1beta1/services/speech/transports/base.py index 9cda1777..4a31d86b 100644 --- a/google/cloud/speech_v1p1beta1/services/speech/transports/base.py +++ b/google/cloud/speech_v1p1beta1/services/speech/transports/base.py @@ -25,6 +25,7 @@ from google.api_core import retry as retries # type: ignore from google.api_core import operations_v1 # type: ignore from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore from google.cloud.speech_v1p1beta1.types import cloud_speech from google.longrunning import operations_pb2 # type: ignore @@ -45,8 +46,6 @@ except pkg_resources.DistributionNotFound: # pragma: NO COVER _GOOGLE_AUTH_VERSION = None -_API_CORE_VERSION = google.api_core.__version__ - class SpeechTransport(abc.ABC): """Abstract transport class for Speech.""" @@ -64,6 +63,7 @@ def __init__( 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, **kwargs, ) -> None: """Instantiate the transport. @@ -87,6 +87,8 @@ def __init__( 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. """ # Save the hostname. Default to port 443 (HTTPS) if none is specified. if ":" not in host: @@ -115,13 +117,20 @@ def __init__( **scopes_kwargs, quota_project_id=quota_project_id ) + # If the credentials is 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 - # TODO(busunkim): These two class methods are in the base transport + # TODO(busunkim): This method is in the base transport # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-api-core - # and google-auth are increased. + # should be deleted once the minimum required versions of google-auth is increased. # TODO: Remove this function once google-auth >= 1.25.0 is required @classmethod @@ -142,27 +151,6 @@ def _get_scopes_kwargs( return scopes_kwargs - # TODO: Remove this function once google-api-core >= 1.26.0 is required - @classmethod - def _get_self_signed_jwt_kwargs( - cls, host: str, scopes: Optional[Sequence[str]] - ) -> Dict[str, Union[Optional[Sequence[str]], str]]: - """Returns kwargs to pass to grpc_helpers.create_channel depending on the google-api-core version""" - - self_signed_jwt_kwargs: Dict[str, Union[Optional[Sequence[str]], str]] = {} - - if _API_CORE_VERSION and ( - packaging.version.parse(_API_CORE_VERSION) - >= packaging.version.parse("1.26.0") - ): - self_signed_jwt_kwargs["default_scopes"] = cls.AUTH_SCOPES - self_signed_jwt_kwargs["scopes"] = scopes - self_signed_jwt_kwargs["default_host"] = cls.DEFAULT_HOST - else: - self_signed_jwt_kwargs["scopes"] = scopes or cls.AUTH_SCOPES - - return self_signed_jwt_kwargs - def _prep_wrapped_messages(self, client_info): # Precompute the wrapped methods. self._wrapped_methods = { diff --git a/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py b/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py index 422a571e..f5f7af83 100644 --- a/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py +++ b/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py @@ -152,6 +152,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: @@ -207,14 +208,14 @@ def create_channel( and ``credentials_file`` are passed. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) diff --git a/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py b/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py index 1bfc2094..fbb92d83 100644 --- a/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py +++ b/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py @@ -80,14 +80,14 @@ def create_channel( aio.Channel: A gRPC AsyncIO channel object. """ - self_signed_jwt_kwargs = cls._get_self_signed_jwt_kwargs(host, scopes) - return grpc_helpers_async.create_channel( host, credentials=credentials, credentials_file=credentials_file, quota_project_id=quota_project_id, - **self_signed_jwt_kwargs, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, **kwargs, ) @@ -198,6 +198,7 @@ def __init__( scopes=scopes, quota_project_id=quota_project_id, client_info=client_info, + always_use_jwt_access=True, ) if not self._grpc_channel: diff --git a/owl-bot-staging/v1/.coveragerc b/owl-bot-staging/v1/.coveragerc deleted file mode 100644 index f539ecf8..00000000 --- a/owl-bot-staging/v1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/speech/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 4a6fc4e7..00000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/speech *.py -recursive-include google/cloud/speech_v1 *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 36384b14..00000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Speech 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 Speech 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/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index 567befa2..00000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,376 +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 -# -# 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-speech 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 = "1.6.3" - -# 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 master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-speech" -copyright = u"2020, 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 = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# 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-speech-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 = [ - ( - master_doc, - "google-cloud-speech.tex", - u"google-cloud-speech 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 = [ - ( - master_doc, - "google-cloud-speech", - u"Google Cloud Speech 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 = [ - ( - master_doc, - "google-cloud-speech", - u"google-cloud-speech Documentation", - author, - "google-cloud-speech", - "GAPIC library for Google Cloud Speech 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/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index 20c367af..00000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - speech_v1/services - speech_v1/types diff --git a/owl-bot-staging/v1/docs/speech_v1/services.rst b/owl-bot-staging/v1/docs/speech_v1/services.rst deleted file mode 100644 index 07e11e84..00000000 --- a/owl-bot-staging/v1/docs/speech_v1/services.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Speech v1 API -======================================= -.. toctree:: - :maxdepth: 2 - - speech diff --git a/owl-bot-staging/v1/docs/speech_v1/speech.rst b/owl-bot-staging/v1/docs/speech_v1/speech.rst deleted file mode 100644 index 53fc9d38..00000000 --- a/owl-bot-staging/v1/docs/speech_v1/speech.rst +++ /dev/null @@ -1,6 +0,0 @@ -Speech ------------------------- - -.. automodule:: google.cloud.speech_v1.services.speech - :members: - :inherited-members: diff --git a/owl-bot-staging/v1/docs/speech_v1/types.rst b/owl-bot-staging/v1/docs/speech_v1/types.rst deleted file mode 100644 index 1ca37b89..00000000 --- a/owl-bot-staging/v1/docs/speech_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Speech v1 API -==================================== - -.. automodule:: google.cloud.speech_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech/__init__.py deleted file mode 100644 index 937aef0d..00000000 --- a/owl-bot-staging/v1/google/cloud/speech/__init__.py +++ /dev/null @@ -1,57 +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 -# -# 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.speech_v1.services.speech.client import SpeechClient -from google.cloud.speech_v1.services.speech.async_client import SpeechAsyncClient - -from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeMetadata -from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeRequest -from google.cloud.speech_v1.types.cloud_speech import LongRunningRecognizeResponse -from google.cloud.speech_v1.types.cloud_speech import RecognitionAudio -from google.cloud.speech_v1.types.cloud_speech import RecognitionConfig -from google.cloud.speech_v1.types.cloud_speech import RecognitionMetadata -from google.cloud.speech_v1.types.cloud_speech import RecognizeRequest -from google.cloud.speech_v1.types.cloud_speech import RecognizeResponse -from google.cloud.speech_v1.types.cloud_speech import SpeakerDiarizationConfig -from google.cloud.speech_v1.types.cloud_speech import SpeechContext -from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionAlternative -from google.cloud.speech_v1.types.cloud_speech import SpeechRecognitionResult -from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionConfig -from google.cloud.speech_v1.types.cloud_speech import StreamingRecognitionResult -from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeRequest -from google.cloud.speech_v1.types.cloud_speech import StreamingRecognizeResponse -from google.cloud.speech_v1.types.cloud_speech import WordInfo - -__all__ = ('SpeechClient', - 'SpeechAsyncClient', - 'LongRunningRecognizeMetadata', - 'LongRunningRecognizeRequest', - 'LongRunningRecognizeResponse', - 'RecognitionAudio', - 'RecognitionConfig', - 'RecognitionMetadata', - 'RecognizeRequest', - 'RecognizeResponse', - 'SpeakerDiarizationConfig', - 'SpeechContext', - 'SpeechRecognitionAlternative', - 'SpeechRecognitionResult', - 'StreamingRecognitionConfig', - 'StreamingRecognitionResult', - 'StreamingRecognizeRequest', - 'StreamingRecognizeResponse', - 'WordInfo', -) diff --git a/owl-bot-staging/v1/google/cloud/speech/py.typed b/owl-bot-staging/v1/google/cloud/speech/py.typed deleted file mode 100644 index 02081c09..00000000 --- a/owl-bot-staging/v1/google/cloud/speech/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py deleted file mode 100644 index 55e62366..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/__init__.py +++ /dev/null @@ -1,58 +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 -# -# 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 .services.speech import SpeechClient -from .services.speech import SpeechAsyncClient - -from .types.cloud_speech import LongRunningRecognizeMetadata -from .types.cloud_speech import LongRunningRecognizeRequest -from .types.cloud_speech import LongRunningRecognizeResponse -from .types.cloud_speech import RecognitionAudio -from .types.cloud_speech import RecognitionConfig -from .types.cloud_speech import RecognitionMetadata -from .types.cloud_speech import RecognizeRequest -from .types.cloud_speech import RecognizeResponse -from .types.cloud_speech import SpeakerDiarizationConfig -from .types.cloud_speech import SpeechContext -from .types.cloud_speech import SpeechRecognitionAlternative -from .types.cloud_speech import SpeechRecognitionResult -from .types.cloud_speech import StreamingRecognitionConfig -from .types.cloud_speech import StreamingRecognitionResult -from .types.cloud_speech import StreamingRecognizeRequest -from .types.cloud_speech import StreamingRecognizeResponse -from .types.cloud_speech import WordInfo - -__all__ = ( - 'SpeechAsyncClient', -'LongRunningRecognizeMetadata', -'LongRunningRecognizeRequest', -'LongRunningRecognizeResponse', -'RecognitionAudio', -'RecognitionConfig', -'RecognitionMetadata', -'RecognizeRequest', -'RecognizeResponse', -'SpeakerDiarizationConfig', -'SpeechClient', -'SpeechContext', -'SpeechRecognitionAlternative', -'SpeechRecognitionResult', -'StreamingRecognitionConfig', -'StreamingRecognitionResult', -'StreamingRecognizeRequest', -'StreamingRecognizeResponse', -'WordInfo', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json b/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json deleted file mode 100644 index 8775ccc2..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/gapic_metadata.json +++ /dev/null @@ -1,53 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.speech_v1", - "protoPackage": "google.cloud.speech.v1", - "schema": "1.0", - "services": { - "Speech": { - "clients": { - "grpc": { - "libraryClient": "SpeechClient", - "rpcs": { - "LongRunningRecognize": { - "methods": [ - "long_running_recognize" - ] - }, - "Recognize": { - "methods": [ - "recognize" - ] - }, - "StreamingRecognize": { - "methods": [ - "streaming_recognize" - ] - } - } - }, - "grpc-async": { - "libraryClient": "SpeechAsyncClient", - "rpcs": { - "LongRunningRecognize": { - "methods": [ - "long_running_recognize" - ] - }, - "Recognize": { - "methods": [ - "recognize" - ] - }, - "StreamingRecognize": { - "methods": [ - "streaming_recognize" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/py.typed b/owl-bot-staging/v1/google/cloud/speech_v1/py.typed deleted file mode 100644 index 02081c09..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py deleted file mode 100644 index 4de65971..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/__init__.py +++ /dev/null @@ -1,15 +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 -# -# 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/v1/google/cloud/speech_v1/services/speech/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py deleted file mode 100644 index 13e0fa86..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/__init__.py +++ /dev/null @@ -1,22 +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 -# -# 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 SpeechClient -from .async_client import SpeechAsyncClient - -__all__ = ( - 'SpeechClient', - 'SpeechAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py deleted file mode 100644 index 7529ca84..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/async_client.py +++ /dev/null @@ -1,464 +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 -# -# 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, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.speech_v1.types import cloud_speech -from google.rpc import status_pb2 # type: ignore -from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport -from .client import SpeechClient - - -class SpeechAsyncClient: - """Service that implements Google Cloud Speech API.""" - - _client: SpeechClient - - DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT - - common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) - common_folder_path = staticmethod(SpeechClient.common_folder_path) - parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) - common_organization_path = staticmethod(SpeechClient.common_organization_path) - parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) - common_project_path = staticmethod(SpeechClient.common_project_path) - parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) - common_location_path = staticmethod(SpeechClient.common_location_path) - parse_common_location_path = staticmethod(SpeechClient.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: - SpeechAsyncClient: The constructed client. - """ - return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: - SpeechAsyncClient: The constructed client. - """ - return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> SpeechTransport: - """Returns the transport used by the client instance. - - Returns: - SpeechTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, SpeechTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def recognize(self, - request: cloud_speech.RecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_speech.RecognizeResponse: - r"""Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Args: - request (:class:`google.cloud.speech_v1.types.RecognizeRequest`): - The request object. The top-level message sent by the - client for the `Recognize` method. - config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: - The only message returned to the client by the Recognize method. It - contains the result as zero or more sequential - SpeechRecognitionResult messages. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 = cloud_speech.RecognizeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def long_running_recognize(self, - request: cloud_speech.LongRunningRecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Args: - request (:class:`google.cloud.speech_v1.types.LongRunningRecognizeRequest`): - The request object. The top-level message sent by the - client for the `LongRunningRecognize` method. - config (:class:`google.cloud.speech_v1.types.RecognitionConfig`): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (:class:`google.cloud.speech_v1.types.RecognitionAudio`): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. - It contains the result as zero or more sequential - SpeechRecognitionResult messages. It is included in - the result.response field of the Operation returned - by the GetOperation call of the - google::longrunning::Operations service. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 = cloud_speech.LongRunningRecognizeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.long_running_recognize, - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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, - cloud_speech.LongRunningRecognizeResponse, - metadata_type=cloud_speech.LongRunningRecognizeMetadata, - ) - - # Done; return the response. - return response - - def streaming_recognize(self, - requests: AsyncIterator[cloud_speech.StreamingRecognizeRequest] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: - r"""Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Args: - requests (AsyncIterator[`google.cloud.speech_v1.types.StreamingRecognizeRequest`]): - The request object AsyncIterator. The top-level message sent by the - client for the `StreamingRecognize` method. Multiple - `StreamingRecognizeRequest` messages are sent. The first - message must contain a `streaming_config` message and - must not contain `audio_content`. All subsequent - messages must contain `audio_content` and must not - contain a `streaming_config` message. - 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: - AsyncIterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: - StreamingRecognizeResponse is the only message returned to the client by - StreamingRecognize. A series of zero or more - StreamingRecognizeResponse messages are streamed back - to the client. If there is no recognizable audio, and - single_utterance is set to false, then no messages - are streamed back to the client. - - Here's an example of a series of ten - StreamingRecognizeResponses that might be returned - while processing audio: - - 1. results { alternatives { transcript: "tube" } - stability: 0.01 } - 2. results { alternatives { transcript: "to be a" } - stability: 0.01 } - 3. results { alternatives { transcript: "to be" } - stability: 0.9 } results { alternatives { - transcript: " or not to be" } stability: 0.01 } - 4. - - results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } - - alternatives { transcript: "to bee or not to bee" } - is_final: true } - - 5. results { alternatives { transcript: " that's" } - stability: 0.01 } - 6. results { alternatives { transcript: " that is" } - stability: 0.9 } results { alternatives { - transcript: " the question" } stability: 0.01 } - 7. - - results { alternatives { transcript: " that is the question" - confidence: 0.98 } - - alternatives { transcript: " that was the question" } - is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain - final results; they are indicated by - is_final: true. Concatenating these together - generates the full transcript: "to be or not to be - that is the question". - - The others contain interim results. #3 and #6 - contain two interim \`results`: the first portion - has a high stability and is less likely to change; - the second portion has a low stability and is very - likely to change. A UI designer might choose to - show only high stability results. - - The specific stability and confidence values shown - above are only for illustrative purposes. Actual - values may vary. - - - - In each response, only one of these fields will be set: - error, speech_event_type, or one or more - (repeated) results. - - """ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.streaming_recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = rpc( - requests, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SpeechAsyncClient", -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py deleted file mode 100644 index ec1a669b..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/client.py +++ /dev/null @@ -1,624 +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 -# -# 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 distutils import util -import os -import re -from typing import Callable, Dict, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.speech_v1.types import cloud_speech -from google.rpc import status_pb2 # type: ignore -from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import SpeechGrpcTransport -from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport - - -class SpeechClientMeta(type): - """Metaclass for the Speech 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[SpeechTransport]] - _transport_registry["grpc"] = SpeechGrpcTransport - _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[SpeechTransport]: - """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 SpeechClient(metaclass=SpeechClientMeta): - """Service that implements Google Cloud Speech API.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "speech.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: - SpeechClient: 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: - SpeechClient: 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) -> SpeechTransport: - """Returns the transport used by the client instance. - - Returns: - SpeechTransport: The transport used by the client - instance. - """ - return self._transport - - @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 {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, SpeechTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the speech 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, SpeechTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.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. - 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() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # 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, SpeechTransport): - # transport is a SpeechTransport instance. - if credentials or client_options.credentials_file: - 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: - 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, - ) - - def recognize(self, - request: cloud_speech.RecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_speech.RecognizeResponse: - r"""Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Args: - request (google.cloud.speech_v1.types.RecognizeRequest): - The request object. The top-level message sent by the - client for the `Recognize` method. - config (google.cloud.speech_v1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (google.cloud.speech_v1.types.RecognitionAudio): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1.types.RecognizeResponse: - The only message returned to the client by the Recognize method. It - contains the result as zero or more sequential - SpeechRecognitionResult messages. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 cloud_speech.RecognizeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech.RecognizeRequest): - request = cloud_speech.RecognizeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.recognize] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def long_running_recognize(self, - request: cloud_speech.LongRunningRecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Args: - request (google.cloud.speech_v1.types.LongRunningRecognizeRequest): - The request object. The top-level message sent by the - client for the `LongRunningRecognize` method. - config (google.cloud.speech_v1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (google.cloud.speech_v1.types.RecognitionAudio): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. - It contains the result as zero or more sequential - SpeechRecognitionResult messages. It is included in - the result.response field of the Operation returned - by the GetOperation call of the - google::longrunning::Operations service. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 cloud_speech.LongRunningRecognizeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): - request = cloud_speech.LongRunningRecognizeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] - - # 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, - cloud_speech.LongRunningRecognizeResponse, - metadata_type=cloud_speech.LongRunningRecognizeMetadata, - ) - - # Done; return the response. - return response - - def streaming_recognize(self, - requests: Iterator[cloud_speech.StreamingRecognizeRequest] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: - r"""Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Args: - requests (Iterator[google.cloud.speech_v1.types.StreamingRecognizeRequest]): - The request object iterator. The top-level message sent by the - client for the `StreamingRecognize` method. Multiple - `StreamingRecognizeRequest` messages are sent. The first - message must contain a `streaming_config` message and - must not contain `audio_content`. All subsequent - messages must contain `audio_content` and must not - contain a `streaming_config` message. - 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: - Iterable[google.cloud.speech_v1.types.StreamingRecognizeResponse]: - StreamingRecognizeResponse is the only message returned to the client by - StreamingRecognize. A series of zero or more - StreamingRecognizeResponse messages are streamed back - to the client. If there is no recognizable audio, and - single_utterance is set to false, then no messages - are streamed back to the client. - - Here's an example of a series of ten - StreamingRecognizeResponses that might be returned - while processing audio: - - 1. results { alternatives { transcript: "tube" } - stability: 0.01 } - 2. results { alternatives { transcript: "to be a" } - stability: 0.01 } - 3. results { alternatives { transcript: "to be" } - stability: 0.9 } results { alternatives { - transcript: " or not to be" } stability: 0.01 } - 4. - - results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } - - alternatives { transcript: "to bee or not to bee" } - is_final: true } - - 5. results { alternatives { transcript: " that's" } - stability: 0.01 } - 6. results { alternatives { transcript: " that is" } - stability: 0.9 } results { alternatives { - transcript: " the question" } stability: 0.01 } - 7. - - results { alternatives { transcript: " that is the question" - confidence: 0.98 } - - alternatives { transcript: " that was the question" } - is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain - final results; they are indicated by - is_final: true. Concatenating these together - generates the full transcript: "to be or not to be - that is the question". - - The others contain interim results. #3 and #6 - contain two interim \`results`: the first portion - has a high stability and is less likely to change; - the second portion has a low stability and is very - likely to change. A UI designer might choose to - show only high stability results. - - The specific stability and confidence values shown - above are only for illustrative purposes. Actual - values may vary. - - - - In each response, only one of these fields will be set: - error, speech_event_type, or one or more - (repeated) results. - - """ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] - - # Send the request. - response = rpc( - requests, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SpeechClient", -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py deleted file mode 100644 index 9f7015bc..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/__init__.py +++ /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 -# -# 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 SpeechTransport -from .grpc import SpeechGrpcTransport -from .grpc_asyncio import SpeechGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] -_transport_registry['grpc'] = SpeechGrpcTransport -_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport - -__all__ = ( - 'SpeechTransport', - 'SpeechGrpcTransport', - 'SpeechGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py deleted file mode 100644 index 2e119c5f..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/base.py +++ /dev/null @@ -1,217 +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 -# -# 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 -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.speech_v1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-speech', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class SpeechTransport(abc.ABC): - """Abstract transport class for Speech.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'speech.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: 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, - **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. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes or self.AUTH_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) - - # If the credentials is 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 - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.recognize: gapic_v1.method.wrap_method( - self.recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=client_info, - ), - self.long_running_recognize: gapic_v1.method.wrap_method( - self.long_running_recognize, - default_timeout=5000.0, - client_info=client_info, - ), - self.streaming_recognize: gapic_v1.method.wrap_method( - self.streaming_recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=client_info, - ), - } - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - Union[ - cloud_speech.RecognizeResponse, - Awaitable[cloud_speech.RecognizeResponse] - ]]: - raise NotImplementedError() - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - Union[ - cloud_speech.StreamingRecognizeResponse, - Awaitable[cloud_speech.StreamingRecognizeResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'SpeechTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py deleted file mode 100644 index a653aec0..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc.py +++ /dev/null @@ -1,328 +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 -# -# 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 # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.api_core import gapic_v1 # type: ignore -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.speech_v1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore -from .base import SpeechTransport, DEFAULT_CLIENT_INFO - - -class SpeechGrpcTransport(SpeechTransport): - """gRPC backend transport for Speech. - - Service that implements Google Cloud Speech API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - 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 = 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: 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. - """ - # Sanity 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 recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - cloud_speech.RecognizeResponse]: - r"""Return a callable for the recognize method over gRPC. - - Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Returns: - Callable[[~.RecognizeRequest], - ~.RecognizeResponse]: - 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 'recognize' not in self._stubs: - self._stubs['recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1.Speech/Recognize', - request_serializer=cloud_speech.RecognizeRequest.serialize, - response_deserializer=cloud_speech.RecognizeResponse.deserialize, - ) - return self._stubs['recognize'] - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - operations_pb2.Operation]: - r"""Return a callable for the long running recognize method over gRPC. - - Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Returns: - Callable[[~.LongRunningRecognizeRequest], - ~.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 'long_running_recognize' not in self._stubs: - self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1.Speech/LongRunningRecognize', - request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['long_running_recognize'] - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - cloud_speech.StreamingRecognizeResponse]: - r"""Return a callable for the streaming recognize method over gRPC. - - Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Returns: - Callable[[~.StreamingRecognizeRequest], - ~.StreamingRecognizeResponse]: - 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 'streaming_recognize' not in self._stubs: - self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( - '/google.cloud.speech.v1.Speech/StreamingRecognize', - request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, - response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, - ) - return self._stubs['streaming_recognize'] - - -__all__ = ( - 'SpeechGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py deleted file mode 100644 index d7a1b3a8..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/services/speech/transports/grpc_asyncio.py +++ /dev/null @@ -1,332 +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 -# -# 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 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.speech_v1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore -from .base import SpeechTransport, DEFAULT_CLIENT_INFO -from .grpc import SpeechGrpcTransport - - -class SpeechGrpcAsyncIOTransport(SpeechTransport): - """gRPC AsyncIO backend transport for Speech. - - Service that implements Google Cloud Speech API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'speech.googleapis.com', - credentials: 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - 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 = 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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. - """ - # Sanity 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 recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - Awaitable[cloud_speech.RecognizeResponse]]: - r"""Return a callable for the recognize method over gRPC. - - Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Returns: - Callable[[~.RecognizeRequest], - Awaitable[~.RecognizeResponse]]: - 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 'recognize' not in self._stubs: - self._stubs['recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1.Speech/Recognize', - request_serializer=cloud_speech.RecognizeRequest.serialize, - response_deserializer=cloud_speech.RecognizeResponse.deserialize, - ) - return self._stubs['recognize'] - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the long running recognize method over gRPC. - - Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Returns: - Callable[[~.LongRunningRecognizeRequest], - 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 'long_running_recognize' not in self._stubs: - self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1.Speech/LongRunningRecognize', - request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['long_running_recognize'] - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - Awaitable[cloud_speech.StreamingRecognizeResponse]]: - r"""Return a callable for the streaming recognize method over gRPC. - - Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Returns: - Callable[[~.StreamingRecognizeRequest], - Awaitable[~.StreamingRecognizeResponse]]: - 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 'streaming_recognize' not in self._stubs: - self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( - '/google.cloud.speech.v1.Speech/StreamingRecognize', - request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, - response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, - ) - return self._stubs['streaming_recognize'] - - -__all__ = ( - 'SpeechGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py deleted file mode 100644 index a1cfdd55..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/types/__init__.py +++ /dev/null @@ -1,54 +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 -# -# 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 .cloud_speech import ( - LongRunningRecognizeMetadata, - LongRunningRecognizeRequest, - LongRunningRecognizeResponse, - RecognitionAudio, - RecognitionConfig, - RecognitionMetadata, - RecognizeRequest, - RecognizeResponse, - SpeakerDiarizationConfig, - SpeechContext, - SpeechRecognitionAlternative, - SpeechRecognitionResult, - StreamingRecognitionConfig, - StreamingRecognitionResult, - StreamingRecognizeRequest, - StreamingRecognizeResponse, - WordInfo, -) - -__all__ = ( - 'LongRunningRecognizeMetadata', - 'LongRunningRecognizeRequest', - 'LongRunningRecognizeResponse', - 'RecognitionAudio', - 'RecognitionConfig', - 'RecognitionMetadata', - 'RecognizeRequest', - 'RecognizeResponse', - 'SpeakerDiarizationConfig', - 'SpeechContext', - 'SpeechRecognitionAlternative', - 'SpeechRecognitionResult', - 'StreamingRecognitionConfig', - 'StreamingRecognitionResult', - 'StreamingRecognizeRequest', - 'StreamingRecognizeResponse', - 'WordInfo', -) diff --git a/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py b/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py deleted file mode 100644 index cb840a3a..00000000 --- a/owl-bot-staging/v1/google/cloud/speech_v1/types/cloud_speech.py +++ /dev/null @@ -1,989 +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 -# -# 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 proto # type: ignore - -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.speech.v1', - manifest={ - 'RecognizeRequest', - 'LongRunningRecognizeRequest', - 'StreamingRecognizeRequest', - 'StreamingRecognitionConfig', - 'RecognitionConfig', - 'SpeakerDiarizationConfig', - 'RecognitionMetadata', - 'SpeechContext', - 'RecognitionAudio', - 'RecognizeResponse', - 'LongRunningRecognizeResponse', - 'LongRunningRecognizeMetadata', - 'StreamingRecognizeResponse', - 'StreamingRecognitionResult', - 'SpeechRecognitionResult', - 'SpeechRecognitionAlternative', - 'WordInfo', - }, -) - - -class RecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the ``Recognize`` - method. - - Attributes: - config (google.cloud.speech_v1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - audio (google.cloud.speech_v1.types.RecognitionAudio): - Required. The audio data to be recognized. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - audio = proto.Field( - proto.MESSAGE, - number=2, - message='RecognitionAudio', - ) - - -class LongRunningRecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the - ``LongRunningRecognize`` method. - - Attributes: - config (google.cloud.speech_v1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - audio (google.cloud.speech_v1.types.RecognitionAudio): - Required. The audio data to be recognized. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - audio = proto.Field( - proto.MESSAGE, - number=2, - message='RecognitionAudio', - ) - - -class StreamingRecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the - ``StreamingRecognize`` method. Multiple - ``StreamingRecognizeRequest`` messages are sent. The first message - must contain a ``streaming_config`` message and must not contain - ``audio_content``. All subsequent messages must contain - ``audio_content`` and must not contain a ``streaming_config`` - message. - - Attributes: - streaming_config (google.cloud.speech_v1.types.StreamingRecognitionConfig): - Provides information to the recognizer that specifies how to - process the request. The first ``StreamingRecognizeRequest`` - message must contain a ``streaming_config`` message. - audio_content (bytes): - The audio data to be recognized. Sequential chunks of audio - data are sent in sequential ``StreamingRecognizeRequest`` - messages. The first ``StreamingRecognizeRequest`` message - must not contain ``audio_content`` data and all subsequent - ``StreamingRecognizeRequest`` messages must contain - ``audio_content`` data. The audio bytes must be encoded as - specified in ``RecognitionConfig``. Note: as with all bytes - fields, proto buffers use a pure binary representation (not - base64). See `content - limits `__. - """ - - streaming_config = proto.Field( - proto.MESSAGE, - number=1, - oneof='streaming_request', - message='StreamingRecognitionConfig', - ) - audio_content = proto.Field( - proto.BYTES, - number=2, - oneof='streaming_request', - ) - - -class StreamingRecognitionConfig(proto.Message): - r"""Provides information to the recognizer that specifies how to - process the request. - - Attributes: - config (google.cloud.speech_v1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - single_utterance (bool): - If ``false`` or omitted, the recognizer will perform - continuous recognition (continuing to wait for and process - audio even if the user pauses speaking) until the client - closes the input stream (gRPC API) or until the maximum time - limit has been reached. May return multiple - ``StreamingRecognitionResult``\ s with the ``is_final`` flag - set to ``true``. - - If ``true``, the recognizer will detect a single spoken - utterance. When it detects that the user has paused or - stopped speaking, it will return an - ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It - will return no more than one ``StreamingRecognitionResult`` - with the ``is_final`` flag set to ``true``. - interim_results (bool): - If ``true``, interim results (tentative hypotheses) may be - returned as they become available (these interim results are - indicated with the ``is_final=false`` flag). If ``false`` or - omitted, only ``is_final=true`` result(s) are returned. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - single_utterance = proto.Field( - proto.BOOL, - number=2, - ) - interim_results = proto.Field( - proto.BOOL, - number=3, - ) - - -class RecognitionConfig(proto.Message): - r"""Provides information to the recognizer that specifies how to - process the request. - - Attributes: - encoding (google.cloud.speech_v1.types.RecognitionConfig.AudioEncoding): - Encoding of audio data sent in all ``RecognitionAudio`` - messages. This field is optional for ``FLAC`` and ``WAV`` - audio files and required for all other audio formats. For - details, see - [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. - sample_rate_hertz (int): - Sample rate in Hertz of the audio data sent in all - ``RecognitionAudio`` messages. Valid values are: 8000-48000. - 16000 is optimal. For best results, set the sampling rate of - the audio source to 16000 Hz. If that's not possible, use - the native sample rate of the audio source (instead of - re-sampling). This field is optional for FLAC and WAV audio - files, but is required for all other audio formats. For - details, see - [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding]. - audio_channel_count (int): - The number of channels in the input audio data. ONLY set - this for MULTI-CHANNEL recognition. Valid values for - LINEAR16 and FLAC are ``1``-``8``. Valid values for OGG_OPUS - are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and - SPEEX_WITH_HEADER_BYTE is only ``1``. If ``0`` or omitted, - defaults to one channel (mono). Note: We only recognize the - first channel by default. To perform independent recognition - on each channel set - ``enable_separate_recognition_per_channel`` to 'true'. - enable_separate_recognition_per_channel (bool): - This needs to be set to ``true`` explicitly and - ``audio_channel_count`` > 1 to get each channel recognized - separately. The recognition result will contain a - ``channel_tag`` field to state which channel that result - belongs to. If this is not true, we will only recognize the - first channel. The request is billed cumulatively for all - channels recognized: ``audio_channel_count`` multiplied by - the length of the audio. - language_code (str): - Required. The language of the supplied audio as a - `BCP-47 `__ - language tag. Example: "en-US". See `Language - Support `__ - for a list of the currently supported language codes. - max_alternatives (int): - Maximum number of recognition hypotheses to be returned. - Specifically, the maximum number of - ``SpeechRecognitionAlternative`` messages within each - ``SpeechRecognitionResult``. The server may return fewer - than ``max_alternatives``. Valid values are ``0``-``30``. A - value of ``0`` or ``1`` will return a maximum of one. If - omitted, will return a maximum of one. - profanity_filter (bool): - If set to ``true``, the server will attempt to filter out - profanities, replacing all but the initial character in each - filtered word with asterisks, e.g. "f***". If set to - ``false`` or omitted, profanities won't be filtered out. - speech_contexts (Sequence[google.cloud.speech_v1.types.SpeechContext]): - Array of - [SpeechContext][google.cloud.speech.v1.SpeechContext]. A - means to provide context to assist the speech recognition. - For more information, see `speech - adaptation `__. - enable_word_time_offsets (bool): - If ``true``, the top result includes a list of words and the - start and end time offsets (timestamps) for those words. If - ``false``, no word-level time offset information is - returned. The default is ``false``. - enable_automatic_punctuation (bool): - If 'true', adds punctuation to recognition - result hypotheses. This feature is only - available in select languages. Setting this for - requests in other languages has no effect at - all. The default 'false' value does not add - punctuation to result hypotheses. Note: This is - currently offered as an experimental service, - complimentary to all users. In the future this - may be exclusively available as a premium - feature. - diarization_config (google.cloud.speech_v1.types.SpeakerDiarizationConfig): - Config to enable speaker diarization and set - additional parameters to make diarization better - suited for your application. Note: When this is - enabled, we send all the words from the - beginning of the audio for the top alternative - in every consecutive STREAMING responses. This - is done in order to improve our speaker tags as - our models learn to identify the speakers in the - conversation over time. For non-streaming - requests, the diarization results will be - provided only in the top alternative of the - FINAL SpeechRecognitionResult. - metadata (google.cloud.speech_v1.types.RecognitionMetadata): - Metadata regarding this request. - model (str): - Which model to select for the given request. Select the - model best suited to your domain to get best results. If a - model is not explicitly specified, then we auto-select a - model based on the parameters in the RecognitionConfig. - - .. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ModelDescription
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically - recorded at an 8khz sampling rate).
videoBest for audio that originated from from video or includes multiple - speakers. Ideally the audio is recorded at a 16khz or greater - sampling rate. This is a premium model that costs more than the - standard rate.
defaultBest for audio that is not one of the specific audio models. - For example, long-form audio. Ideally the audio is high-fidelity, - recorded at a 16khz or greater sampling rate.
- use_enhanced (bool): - Set to true to use an enhanced model for speech recognition. - If ``use_enhanced`` is set to true and the ``model`` field - is not set, then an appropriate enhanced model is chosen if - an enhanced model exists for the audio. - - If ``use_enhanced`` is true and an enhanced version of the - specified model does not exist, then the speech is - recognized using the standard version of the specified - model. - """ - class AudioEncoding(proto.Enum): - r"""The encoding of the audio data sent in the request. - - All encodings support only 1 channel (mono) audio, unless the - ``audio_channel_count`` and - ``enable_separate_recognition_per_channel`` fields are set. - - For best results, the audio source should be captured and - transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). - The accuracy of the speech recognition can be reduced if lossy - codecs are used to capture or transmit audio, particularly if - background noise is present. Lossy codecs include ``MULAW``, - ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, and - ``MP3``. - - The ``FLAC`` and ``WAV`` audio file formats include a header that - describes the included audio content. You can request recognition - for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` - encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in - your request, you do not need to specify an ``AudioEncoding``; the - audio encoding format is determined from the file header. If you - specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` - audio, the encoding configuration must match the encoding described - in the audio header; otherwise the request returns an - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] - error code. - """ - ENCODING_UNSPECIFIED = 0 - LINEAR16 = 1 - FLAC = 2 - MULAW = 3 - AMR = 4 - AMR_WB = 5 - OGG_OPUS = 6 - SPEEX_WITH_HEADER_BYTE = 7 - - encoding = proto.Field( - proto.ENUM, - number=1, - enum=AudioEncoding, - ) - sample_rate_hertz = proto.Field( - proto.INT32, - number=2, - ) - audio_channel_count = proto.Field( - proto.INT32, - number=7, - ) - enable_separate_recognition_per_channel = proto.Field( - proto.BOOL, - number=12, - ) - language_code = proto.Field( - proto.STRING, - number=3, - ) - max_alternatives = proto.Field( - proto.INT32, - number=4, - ) - profanity_filter = proto.Field( - proto.BOOL, - number=5, - ) - speech_contexts = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='SpeechContext', - ) - enable_word_time_offsets = proto.Field( - proto.BOOL, - number=8, - ) - enable_automatic_punctuation = proto.Field( - proto.BOOL, - number=11, - ) - diarization_config = proto.Field( - proto.MESSAGE, - number=19, - message='SpeakerDiarizationConfig', - ) - metadata = proto.Field( - proto.MESSAGE, - number=9, - message='RecognitionMetadata', - ) - model = proto.Field( - proto.STRING, - number=13, - ) - use_enhanced = proto.Field( - proto.BOOL, - number=14, - ) - - -class SpeakerDiarizationConfig(proto.Message): - r"""Config to enable speaker diarization. - Attributes: - enable_speaker_diarization (bool): - If 'true', enables speaker detection for each recognized - word in the top alternative of the recognition result using - a speaker_tag provided in the WordInfo. - min_speaker_count (int): - Minimum number of speakers in the - conversation. This range gives you more - flexibility by allowing the system to - automatically determine the correct number of - speakers. If not set, the default value is 2. - max_speaker_count (int): - Maximum number of speakers in the - conversation. This range gives you more - flexibility by allowing the system to - automatically determine the correct number of - speakers. If not set, the default value is 6. - speaker_tag (int): - Unused. - """ - - enable_speaker_diarization = proto.Field( - proto.BOOL, - number=1, - ) - min_speaker_count = proto.Field( - proto.INT32, - number=2, - ) - max_speaker_count = proto.Field( - proto.INT32, - number=3, - ) - speaker_tag = proto.Field( - proto.INT32, - number=5, - ) - - -class RecognitionMetadata(proto.Message): - r"""Description of audio data to be recognized. - Attributes: - interaction_type (google.cloud.speech_v1.types.RecognitionMetadata.InteractionType): - The use case most closely describing the - audio content to be recognized. - industry_naics_code_of_audio (int): - The industry vertical to which this speech - recognition request most closely applies. This - is most indicative of the topics contained in - the audio. Use the 6-digit NAICS code to - identify the industry vertical - see - https://www.naics.com/search/. - microphone_distance (google.cloud.speech_v1.types.RecognitionMetadata.MicrophoneDistance): - The audio type that most closely describes - the audio being recognized. - original_media_type (google.cloud.speech_v1.types.RecognitionMetadata.OriginalMediaType): - The original media the speech was recorded - on. - recording_device_type (google.cloud.speech_v1.types.RecognitionMetadata.RecordingDeviceType): - The type of device the speech was recorded - with. - recording_device_name (str): - The device used to make the recording. - Examples 'Nexus 5X' or 'Polycom SoundStation IP - 6000' or 'POTS' or 'VoIP' or 'Cardioid - Microphone'. - original_mime_type (str): - Mime type of the original audio file. For example - ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, - ``audio/3gpp``. A list of possible audio mime types is - maintained at - http://www.iana.org/assignments/media-types/media-types.xhtml#audio - audio_topic (str): - Description of the content. Eg. "Recordings - of federal supreme court hearings from 2012". - """ - class InteractionType(proto.Enum): - r"""Use case categories that the audio recognition request can be - described by. - """ - INTERACTION_TYPE_UNSPECIFIED = 0 - DISCUSSION = 1 - PRESENTATION = 2 - PHONE_CALL = 3 - VOICEMAIL = 4 - PROFESSIONALLY_PRODUCED = 5 - VOICE_SEARCH = 6 - VOICE_COMMAND = 7 - DICTATION = 8 - - class MicrophoneDistance(proto.Enum): - r"""Enumerates the types of capture settings describing an audio - file. - """ - MICROPHONE_DISTANCE_UNSPECIFIED = 0 - NEARFIELD = 1 - MIDFIELD = 2 - FARFIELD = 3 - - class OriginalMediaType(proto.Enum): - r"""The original media the speech was recorded on.""" - ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 - AUDIO = 1 - VIDEO = 2 - - class RecordingDeviceType(proto.Enum): - r"""The type of device the speech was recorded with.""" - RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 - SMARTPHONE = 1 - PC = 2 - PHONE_LINE = 3 - VEHICLE = 4 - OTHER_OUTDOOR_DEVICE = 5 - OTHER_INDOOR_DEVICE = 6 - - interaction_type = proto.Field( - proto.ENUM, - number=1, - enum=InteractionType, - ) - industry_naics_code_of_audio = proto.Field( - proto.UINT32, - number=3, - ) - microphone_distance = proto.Field( - proto.ENUM, - number=4, - enum=MicrophoneDistance, - ) - original_media_type = proto.Field( - proto.ENUM, - number=5, - enum=OriginalMediaType, - ) - recording_device_type = proto.Field( - proto.ENUM, - number=6, - enum=RecordingDeviceType, - ) - recording_device_name = proto.Field( - proto.STRING, - number=7, - ) - original_mime_type = proto.Field( - proto.STRING, - number=8, - ) - audio_topic = proto.Field( - proto.STRING, - number=10, - ) - - -class SpeechContext(proto.Message): - r"""Provides "hints" to the speech recognizer to favor specific - words and phrases in the results. - - Attributes: - phrases (Sequence[str]): - A list of strings containing words and phrases "hints" so - that the speech recognition is more likely to recognize - them. This can be used to improve the accuracy for specific - words and phrases, for example, if specific commands are - typically spoken by the user. This can also be used to add - additional words to the vocabulary of the recognizer. See - `usage - limits `__. - - List items can also be set to classes for groups of words - that represent common concepts that occur in natural - language. For example, rather than providing phrase hints - for every month of the year, using the $MONTH class improves - the likelihood of correctly transcribing audio that includes - months. - """ - - phrases = proto.RepeatedField( - proto.STRING, - number=1, - ) - - -class RecognitionAudio(proto.Message): - r"""Contains audio data in the encoding specified in the - ``RecognitionConfig``. Either ``content`` or ``uri`` must be - supplied. Supplying both or neither returns - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. - See `content - limits `__. - - Attributes: - content (bytes): - The audio data bytes encoded as specified in - ``RecognitionConfig``. Note: as with all bytes fields, proto - buffers use a pure binary representation, whereas JSON - representations use base64. - uri (str): - URI that points to a file that contains audio data bytes as - specified in ``RecognitionConfig``. The file must not be - compressed (for example, gzip). Currently, only Google Cloud - Storage URIs are supported, which must be specified in the - following format: ``gs://bucket_name/object_name`` (other - URI formats return - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). - For more information, see `Request - URIs `__. - """ - - content = proto.Field( - proto.BYTES, - number=1, - oneof='audio_source', - ) - uri = proto.Field( - proto.STRING, - number=2, - oneof='audio_source', - ) - - -class RecognizeResponse(proto.Message): - r"""The only message returned to the client by the ``Recognize`` method. - It contains the result as zero or more sequential - ``SpeechRecognitionResult`` messages. - - Attributes: - results (Sequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): - Sequential list of transcription results - corresponding to sequential portions of audio. - """ - - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='SpeechRecognitionResult', - ) - - -class LongRunningRecognizeResponse(proto.Message): - r"""The only message returned to the client by the - ``LongRunningRecognize`` method. It contains the result as zero or - more sequential ``SpeechRecognitionResult`` messages. It is included - in the ``result.response`` field of the ``Operation`` returned by - the ``GetOperation`` call of the ``google::longrunning::Operations`` - service. - - Attributes: - results (Sequence[google.cloud.speech_v1.types.SpeechRecognitionResult]): - Sequential list of transcription results - corresponding to sequential portions of audio. - """ - - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='SpeechRecognitionResult', - ) - - -class LongRunningRecognizeMetadata(proto.Message): - r"""Describes the progress of a long-running ``LongRunningRecognize`` - call. It is included in the ``metadata`` field of the ``Operation`` - returned by the ``GetOperation`` call of the - ``google::longrunning::Operations`` service. - - Attributes: - progress_percent (int): - Approximate percentage of audio processed - thus far. Guaranteed to be 100 when the audio is - fully processed and the results are available. - start_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the request was received. - last_update_time (google.protobuf.timestamp_pb2.Timestamp): - Time of the most recent processing update. - """ - - progress_percent = proto.Field( - proto.INT32, - number=1, - ) - start_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - last_update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - - -class StreamingRecognizeResponse(proto.Message): - r"""``StreamingRecognizeResponse`` is the only message returned to the - client by ``StreamingRecognize``. A series of zero or more - ``StreamingRecognizeResponse`` messages are streamed back to the - client. If there is no recognizable audio, and ``single_utterance`` - is set to false, then no messages are streamed back to the client. - - Here's an example of a series of ten - ``StreamingRecognizeResponse``\ s that might be returned while - processing audio: - - 1. results { alternatives { transcript: "tube" } stability: 0.01 } - - 2. results { alternatives { transcript: "to be a" } stability: 0.01 - } - - 3. results { alternatives { transcript: "to be" } stability: 0.9 } - results { alternatives { transcript: " or not to be" } stability: - 0.01 } - - 4. results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } alternatives { transcript: "to bee or not to - bee" } is_final: true } - - 5. results { alternatives { transcript: " that's" } stability: 0.01 - } - - 6. results { alternatives { transcript: " that is" } stability: 0.9 - } results { alternatives { transcript: " the question" } - stability: 0.01 } - - 7. results { alternatives { transcript: " that is the question" - confidence: 0.98 } alternatives { transcript: " that was the - question" } is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain final results; - they are indicated by ``is_final: true``. Concatenating these - together generates the full transcript: "to be or not to be that - is the question". - - - The others contain interim ``results``. #3 and #6 contain two - interim ``results``: the first portion has a high stability and - is less likely to change; the second portion has a low stability - and is very likely to change. A UI designer might choose to show - only high stability ``results``. - - - The specific ``stability`` and ``confidence`` values shown above - are only for illustrative purposes. Actual values may vary. - - - In each response, only one of these fields will be set: - ``error``, ``speech_event_type``, or one or more (repeated) - ``results``. - - Attributes: - error (google.rpc.status_pb2.Status): - If set, returns a [google.rpc.Status][google.rpc.Status] - message that specifies the error for the operation. - results (Sequence[google.cloud.speech_v1.types.StreamingRecognitionResult]): - This repeated list contains zero or more results that - correspond to consecutive portions of the audio currently - being processed. It contains zero or one ``is_final=true`` - result (the newly settled portion), followed by zero or more - ``is_final=false`` results (the interim results). - speech_event_type (google.cloud.speech_v1.types.StreamingRecognizeResponse.SpeechEventType): - Indicates the type of speech event. - """ - class SpeechEventType(proto.Enum): - r"""Indicates the type of speech event.""" - SPEECH_EVENT_UNSPECIFIED = 0 - END_OF_SINGLE_UTTERANCE = 1 - - error = proto.Field( - proto.MESSAGE, - number=1, - message=status_pb2.Status, - ) - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='StreamingRecognitionResult', - ) - speech_event_type = proto.Field( - proto.ENUM, - number=4, - enum=SpeechEventType, - ) - - -class StreamingRecognitionResult(proto.Message): - r"""A streaming speech recognition result corresponding to a - portion of the audio that is currently being processed. - - Attributes: - alternatives (Sequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): - May contain one or more recognition hypotheses (up to the - maximum specified in ``max_alternatives``). These - alternatives are ordered in terms of accuracy, with the top - (first) alternative being the most probable, as ranked by - the recognizer. - is_final (bool): - If ``false``, this ``StreamingRecognitionResult`` represents - an interim result that may change. If ``true``, this is the - final time the speech service will return this particular - ``StreamingRecognitionResult``, the recognizer will not - return any further hypotheses for this portion of the - transcript and corresponding audio. - stability (float): - An estimate of the likelihood that the recognizer will not - change its guess about this interim result. Values range - from 0.0 (completely unstable) to 1.0 (completely stable). - This field is only provided for interim results - (``is_final=false``). The default of 0.0 is a sentinel value - indicating ``stability`` was not set. - result_end_time (google.protobuf.duration_pb2.Duration): - Time offset of the end of this result - relative to the beginning of the audio. - channel_tag (int): - For multi-channel audio, this is the channel number - corresponding to the recognized result for the audio from - that channel. For audio_channel_count = N, its output values - can range from '1' to 'N'. - language_code (str): - The - `BCP-47 `__ - language tag of the language in this result. This language - code was detected to have the most likelihood of being - spoken in the audio. - """ - - alternatives = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SpeechRecognitionAlternative', - ) - is_final = proto.Field( - proto.BOOL, - number=2, - ) - stability = proto.Field( - proto.FLOAT, - number=3, - ) - result_end_time = proto.Field( - proto.MESSAGE, - number=4, - message=duration_pb2.Duration, - ) - channel_tag = proto.Field( - proto.INT32, - number=5, - ) - language_code = proto.Field( - proto.STRING, - number=6, - ) - - -class SpeechRecognitionResult(proto.Message): - r"""A speech recognition result corresponding to a portion of the - audio. - - Attributes: - alternatives (Sequence[google.cloud.speech_v1.types.SpeechRecognitionAlternative]): - May contain one or more recognition hypotheses (up to the - maximum specified in ``max_alternatives``). These - alternatives are ordered in terms of accuracy, with the top - (first) alternative being the most probable, as ranked by - the recognizer. - channel_tag (int): - For multi-channel audio, this is the channel number - corresponding to the recognized result for the audio from - that channel. For audio_channel_count = N, its output values - can range from '1' to 'N'. - """ - - alternatives = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SpeechRecognitionAlternative', - ) - channel_tag = proto.Field( - proto.INT32, - number=2, - ) - - -class SpeechRecognitionAlternative(proto.Message): - r"""Alternative hypotheses (a.k.a. n-best list). - Attributes: - transcript (str): - Transcript text representing the words that - the user spoke. - confidence (float): - The confidence estimate between 0.0 and 1.0. A higher number - indicates an estimated greater likelihood that the - recognized words are correct. This field is set only for the - top alternative of a non-streaming result or, of a streaming - result where ``is_final=true``. This field is not guaranteed - to be accurate and users should not rely on it to be always - provided. The default of 0.0 is a sentinel value indicating - ``confidence`` was not set. - words (Sequence[google.cloud.speech_v1.types.WordInfo]): - A list of word-specific information for each recognized - word. Note: When ``enable_speaker_diarization`` is true, you - will see all the words from the beginning of the audio. - """ - - transcript = proto.Field( - proto.STRING, - number=1, - ) - confidence = proto.Field( - proto.FLOAT, - number=2, - ) - words = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='WordInfo', - ) - - -class WordInfo(proto.Message): - r"""Word-specific information for recognized words. - Attributes: - start_time (google.protobuf.duration_pb2.Duration): - Time offset relative to the beginning of the audio, and - corresponding to the start of the spoken word. This field is - only set if ``enable_word_time_offsets=true`` and only in - the top hypothesis. This is an experimental feature and the - accuracy of the time offset can vary. - end_time (google.protobuf.duration_pb2.Duration): - Time offset relative to the beginning of the audio, and - corresponding to the end of the spoken word. This field is - only set if ``enable_word_time_offsets=true`` and only in - the top hypothesis. This is an experimental feature and the - accuracy of the time offset can vary. - word (str): - The word corresponding to this set of - information. - speaker_tag (int): - A distinct integer value is assigned for every speaker - within the audio. This field specifies which one of those - speakers was detected to have spoken this word. Value ranges - from '1' to diarization_speaker_count. speaker_tag is set if - enable_speaker_diarization = 'true' and only in the top - alternative. - """ - - start_time = proto.Field( - proto.MESSAGE, - number=1, - message=duration_pb2.Duration, - ) - end_time = proto.Field( - proto.MESSAGE, - number=2, - message=duration_pb2.Duration, - ) - word = proto.Field( - proto.STRING, - number=3, - ) - speaker_tag = proto.Field( - proto.INT32, - number=5, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b485..00000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index 25e1412c..00000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,132 +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 -# -# 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 - -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") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/speech_v1/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - 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='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py deleted file mode 100644 index 385dac85..00000000 --- a/owl-bot-staging/v1/scripts/fixup_speech_v1_keywords.py +++ /dev/null @@ -1,178 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -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 speechCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'long_running_recognize': ('config', 'audio', ), - 'recognize': ('config', 'audio', ), - 'streaming_recognize': ('streaming_config', 'audio_content', ), - } - - 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: not a.keyword.value 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=speechCallTransformer(), -): - """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 speech 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/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index 1fe40131..00000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,53 +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 -# -# 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 - -version = '0.1.0' - -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() - -setuptools.setup( - name='google-cloud-speech', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1/tests/__init__.py b/owl-bot-staging/v1/tests/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1/tests/unit/__init__.py b/owl-bot-staging/v1/tests/unit/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1/tests/unit/gapic/speech_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1/tests/unit/gapic/speech_v1/test_speech.py b/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py deleted file mode 100644 index 4713b6e7..00000000 --- a/owl-bot-staging/v1/tests/unit/gapic/speech_v1/test_speech.py +++ /dev/null @@ -1,1362 +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 -# -# 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 mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -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_async # type: ignore -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.speech_v1.services.speech import SpeechAsyncClient -from google.cloud.speech_v1.services.speech import SpeechClient -from google.cloud.speech_v1.services.speech import transports -from google.cloud.speech_v1.services.speech.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.speech_v1.types import cloud_speech -from google.longrunning import operations_pb2 -from google.oauth2 import service_account -from google.rpc import status_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -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 SpeechClient._get_default_mtls_endpoint(None) is None - assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_from_service_account_info(client_class): - 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) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_service_account_always_use_jwt(client_class): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_called_with(True) - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_from_service_account_file(client_class): - 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") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_speech_client_get_transport_class(): - transport = SpeechClient.get_transport_class() - available_transports = [ - transports.SpeechGrpcTransport, - ] - assert transport in available_transports - - transport = SpeechClient.get_transport_class("grpc") - assert transport == transports.SpeechGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) -@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) -def test_speech_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(SpeechClient, '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(SpeechClient, '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(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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - # 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() - - # 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() - - # 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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) -@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_speech_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) - - 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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_speech_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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name): - # 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) - 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, - ) - - -def test_speech_client_client_options_from_dict(): - with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = SpeechClient( - 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, - ) - - -def test_recognize(transport: str = 'grpc', request_type=cloud_speech.RecognizeRequest): - client = SpeechClient( - 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.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse( - ) - response = client.recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_speech.RecognizeResponse) - - -def test_recognize_from_dict(): - test_recognize(request_type=dict) - - -def test_recognize_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 = SpeechClient( - 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.recognize), - '__call__') as call: - client.recognize() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - -@pytest.mark.asyncio -async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): - client = SpeechAsyncClient( - 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.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( - )) - response = await client.recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_speech.RecognizeResponse) - - -@pytest.mark.asyncio -async def test_recognize_async_from_dict(): - await test_recognize_async(request_type=dict) - - -def test_recognize_flattened(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -def test_recognize_flattened_error(): - client = SpeechClient( - 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.recognize( - cloud_speech.RecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -@pytest.mark.asyncio -async def test_recognize_flattened_async(): - client = SpeechAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -@pytest.mark.asyncio -async def test_recognize_flattened_error_async(): - client = SpeechAsyncClient( - 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.recognize( - cloud_speech.RecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -def test_long_running_recognize(transport: str = 'grpc', request_type=cloud_speech.LongRunningRecognizeRequest): - client = SpeechClient( - 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.long_running_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.long_running_recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_long_running_recognize_from_dict(): - test_long_running_recognize(request_type=dict) - - -def test_long_running_recognize_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 = SpeechClient( - 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.long_running_recognize), - '__call__') as call: - client.long_running_recognize() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - -@pytest.mark.asyncio -async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): - client = SpeechAsyncClient( - 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.long_running_recognize), - '__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.long_running_recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_long_running_recognize_async_from_dict(): - await test_long_running_recognize_async(request_type=dict) - - -def test_long_running_recognize_flattened(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.long_running_recognize), - '__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.long_running_recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -def test_long_running_recognize_flattened_error(): - client = SpeechClient( - 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.long_running_recognize( - cloud_speech.LongRunningRecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -@pytest.mark.asyncio -async def test_long_running_recognize_flattened_async(): - client = SpeechAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.long_running_recognize), - '__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.long_running_recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -@pytest.mark.asyncio -async def test_long_running_recognize_flattened_error_async(): - client = SpeechAsyncClient( - 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.long_running_recognize( - cloud_speech.LongRunningRecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -def test_streaming_recognize(transport: str = 'grpc', request_type=cloud_speech.StreamingRecognizeRequest): - client = SpeechClient( - 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() - requests = [request] - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.streaming_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) - response = client.streaming_recognize(iter(requests)) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert next(args[0]) == request - - # Establish that the response is the type that we expect. - for message in response: - assert isinstance(message, cloud_speech.StreamingRecognizeResponse) - - -def test_streaming_recognize_from_dict(): - test_streaming_recognize(request_type=dict) - - -@pytest.mark.asyncio -async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): - client = SpeechAsyncClient( - 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() - requests = [request] - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.streaming_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) - call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) - response = await client.streaming_recognize(iter(requests)) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert next(args[0]) == request - - # Establish that the response is the type that we expect. - message = await response.read() - assert isinstance(message, cloud_speech.StreamingRecognizeResponse) - - -@pytest.mark.asyncio -async def test_streaming_recognize_async_from_dict(): - await test_streaming_recognize_async(request_type=dict) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = SpeechClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.SpeechGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.SpeechGrpcTransport, - ) - -def test_speech_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.SpeechTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_speech_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.speech_v1.services.speech.transports.SpeechTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.SpeechTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'recognize', - 'long_running_recognize', - 'streaming_recognize', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - -@requires_google_auth_gte_1_25_0 -def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport( - 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', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_speech_base_transport_with_credentials_file_old_google_auth(): - # 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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_speech_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.speech_v1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_speech_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) - SpeechClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_speech_auth_adc_old_google_auth(): - # 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) - SpeechClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_speech_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',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_speech_transport_auth_adc_old_google_auth(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") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_speech_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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="speech.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_speech_host_no_port(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), - ) - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_speech_host_with_port(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), - ) - assert client.transport._host == 'speech.googleapis.com:8000' - -def test_speech_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SpeechGrpcTransport( - 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_speech_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SpeechGrpcAsyncIOTransport( - 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_speech_grpc_lro_client(): - client = SpeechClient( - 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_speech_grpc_lro_async_client(): - client = SpeechAsyncClient( - 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_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = SpeechClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = SpeechClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = SpeechClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = SpeechClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = SpeechClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = SpeechClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = SpeechClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = SpeechClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = SpeechClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = SpeechClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: - transport_class = SpeechClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1p1beta1/.coveragerc b/owl-bot-staging/v1p1beta1/.coveragerc deleted file mode 100644 index f539ecf8..00000000 --- a/owl-bot-staging/v1p1beta1/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/speech/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v1p1beta1/MANIFEST.in b/owl-bot-staging/v1p1beta1/MANIFEST.in deleted file mode 100644 index 1f464b43..00000000 --- a/owl-bot-staging/v1p1beta1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/speech *.py -recursive-include google/cloud/speech_v1p1beta1 *.py diff --git a/owl-bot-staging/v1p1beta1/README.rst b/owl-bot-staging/v1p1beta1/README.rst deleted file mode 100644 index 36384b14..00000000 --- a/owl-bot-staging/v1p1beta1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Speech 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 Speech 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/v1p1beta1/docs/conf.py b/owl-bot-staging/v1p1beta1/docs/conf.py deleted file mode 100644 index 567befa2..00000000 --- a/owl-bot-staging/v1p1beta1/docs/conf.py +++ /dev/null @@ -1,376 +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 -# -# 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-speech 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 = "1.6.3" - -# 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 master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-speech" -copyright = u"2020, 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 = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# 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-speech-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 = [ - ( - master_doc, - "google-cloud-speech.tex", - u"google-cloud-speech 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 = [ - ( - master_doc, - "google-cloud-speech", - u"Google Cloud Speech 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 = [ - ( - master_doc, - "google-cloud-speech", - u"google-cloud-speech Documentation", - author, - "google-cloud-speech", - "GAPIC library for Google Cloud Speech 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/v1p1beta1/docs/index.rst b/owl-bot-staging/v1p1beta1/docs/index.rst deleted file mode 100644 index 68cf3cee..00000000 --- a/owl-bot-staging/v1p1beta1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - speech_v1p1beta1/services - speech_v1p1beta1/types diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst deleted file mode 100644 index 7644e3ca..00000000 --- a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/adaptation.rst +++ /dev/null @@ -1,10 +0,0 @@ -Adaptation ----------------------------- - -.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation - :members: - :inherited-members: - -.. automodule:: google.cloud.speech_v1p1beta1.services.adaptation.pagers - :members: - :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst deleted file mode 100644 index d4982074..00000000 --- a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/services.rst +++ /dev/null @@ -1,7 +0,0 @@ -Services for Google Cloud Speech v1p1beta1 API -============================================== -.. toctree:: - :maxdepth: 2 - - adaptation - speech diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst deleted file mode 100644 index bd3e379a..00000000 --- a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/speech.rst +++ /dev/null @@ -1,6 +0,0 @@ -Speech ------------------------- - -.. automodule:: google.cloud.speech_v1p1beta1.services.speech - :members: - :inherited-members: diff --git a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst b/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst deleted file mode 100644 index 004a3819..00000000 --- a/owl-bot-staging/v1p1beta1/docs/speech_v1p1beta1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Speech v1p1beta1 API -=========================================== - -.. automodule:: google.cloud.speech_v1p1beta1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py deleted file mode 100644 index 8e8d26b4..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech/__init__.py +++ /dev/null @@ -1,93 +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 -# -# 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.speech_v1p1beta1.services.adaptation.client import AdaptationClient -from google.cloud.speech_v1p1beta1.services.adaptation.async_client import AdaptationAsyncClient -from google.cloud.speech_v1p1beta1.services.speech.client import SpeechClient -from google.cloud.speech_v1p1beta1.services.speech.async_client import SpeechAsyncClient - -from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeMetadata -from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech import LongRunningRecognizeResponse -from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionAudio -from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionConfig -from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognitionMetadata -from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech import RecognizeResponse -from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeakerDiarizationConfig -from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechContext -from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionAlternative -from google.cloud.speech_v1p1beta1.types.cloud_speech import SpeechRecognitionResult -from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionConfig -from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognitionResult -from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech import StreamingRecognizeResponse -from google.cloud.speech_v1p1beta1.types.cloud_speech import TranscriptOutputConfig -from google.cloud.speech_v1p1beta1.types.cloud_speech import WordInfo -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreateCustomClassRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import CreatePhraseSetRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeleteCustomClassRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import DeletePhraseSetRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetCustomClassRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import GetPhraseSetRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListCustomClassesResponse -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import ListPhraseSetResponse -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdateCustomClassRequest -from google.cloud.speech_v1p1beta1.types.cloud_speech_adaptation import UpdatePhraseSetRequest -from google.cloud.speech_v1p1beta1.types.resource import CustomClass -from google.cloud.speech_v1p1beta1.types.resource import PhraseSet -from google.cloud.speech_v1p1beta1.types.resource import SpeechAdaptation - -__all__ = ('AdaptationClient', - 'AdaptationAsyncClient', - 'SpeechClient', - 'SpeechAsyncClient', - 'LongRunningRecognizeMetadata', - 'LongRunningRecognizeRequest', - 'LongRunningRecognizeResponse', - 'RecognitionAudio', - 'RecognitionConfig', - 'RecognitionMetadata', - 'RecognizeRequest', - 'RecognizeResponse', - 'SpeakerDiarizationConfig', - 'SpeechContext', - 'SpeechRecognitionAlternative', - 'SpeechRecognitionResult', - 'StreamingRecognitionConfig', - 'StreamingRecognitionResult', - 'StreamingRecognizeRequest', - 'StreamingRecognizeResponse', - 'TranscriptOutputConfig', - 'WordInfo', - 'CreateCustomClassRequest', - 'CreatePhraseSetRequest', - 'DeleteCustomClassRequest', - 'DeletePhraseSetRequest', - 'GetCustomClassRequest', - 'GetPhraseSetRequest', - 'ListCustomClassesRequest', - 'ListCustomClassesResponse', - 'ListPhraseSetRequest', - 'ListPhraseSetResponse', - 'UpdateCustomClassRequest', - 'UpdatePhraseSetRequest', - 'CustomClass', - 'PhraseSet', - 'SpeechAdaptation', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed deleted file mode 100644 index 02081c09..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py deleted file mode 100644 index 5de2bbc1..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/__init__.py +++ /dev/null @@ -1,94 +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 -# -# 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 .services.adaptation import AdaptationClient -from .services.adaptation import AdaptationAsyncClient -from .services.speech import SpeechClient -from .services.speech import SpeechAsyncClient - -from .types.cloud_speech import LongRunningRecognizeMetadata -from .types.cloud_speech import LongRunningRecognizeRequest -from .types.cloud_speech import LongRunningRecognizeResponse -from .types.cloud_speech import RecognitionAudio -from .types.cloud_speech import RecognitionConfig -from .types.cloud_speech import RecognitionMetadata -from .types.cloud_speech import RecognizeRequest -from .types.cloud_speech import RecognizeResponse -from .types.cloud_speech import SpeakerDiarizationConfig -from .types.cloud_speech import SpeechContext -from .types.cloud_speech import SpeechRecognitionAlternative -from .types.cloud_speech import SpeechRecognitionResult -from .types.cloud_speech import StreamingRecognitionConfig -from .types.cloud_speech import StreamingRecognitionResult -from .types.cloud_speech import StreamingRecognizeRequest -from .types.cloud_speech import StreamingRecognizeResponse -from .types.cloud_speech import TranscriptOutputConfig -from .types.cloud_speech import WordInfo -from .types.cloud_speech_adaptation import CreateCustomClassRequest -from .types.cloud_speech_adaptation import CreatePhraseSetRequest -from .types.cloud_speech_adaptation import DeleteCustomClassRequest -from .types.cloud_speech_adaptation import DeletePhraseSetRequest -from .types.cloud_speech_adaptation import GetCustomClassRequest -from .types.cloud_speech_adaptation import GetPhraseSetRequest -from .types.cloud_speech_adaptation import ListCustomClassesRequest -from .types.cloud_speech_adaptation import ListCustomClassesResponse -from .types.cloud_speech_adaptation import ListPhraseSetRequest -from .types.cloud_speech_adaptation import ListPhraseSetResponse -from .types.cloud_speech_adaptation import UpdateCustomClassRequest -from .types.cloud_speech_adaptation import UpdatePhraseSetRequest -from .types.resource import CustomClass -from .types.resource import PhraseSet -from .types.resource import SpeechAdaptation - -__all__ = ( - 'AdaptationAsyncClient', - 'SpeechAsyncClient', -'AdaptationClient', -'CreateCustomClassRequest', -'CreatePhraseSetRequest', -'CustomClass', -'DeleteCustomClassRequest', -'DeletePhraseSetRequest', -'GetCustomClassRequest', -'GetPhraseSetRequest', -'ListCustomClassesRequest', -'ListCustomClassesResponse', -'ListPhraseSetRequest', -'ListPhraseSetResponse', -'LongRunningRecognizeMetadata', -'LongRunningRecognizeRequest', -'LongRunningRecognizeResponse', -'PhraseSet', -'RecognitionAudio', -'RecognitionConfig', -'RecognitionMetadata', -'RecognizeRequest', -'RecognizeResponse', -'SpeakerDiarizationConfig', -'SpeechAdaptation', -'SpeechClient', -'SpeechContext', -'SpeechRecognitionAlternative', -'SpeechRecognitionResult', -'StreamingRecognitionConfig', -'StreamingRecognitionResult', -'StreamingRecognizeRequest', -'StreamingRecognizeResponse', -'TranscriptOutputConfig', -'UpdateCustomClassRequest', -'UpdatePhraseSetRequest', -'WordInfo', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json deleted file mode 100644 index 3561c102..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/gapic_metadata.json +++ /dev/null @@ -1,167 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.speech_v1p1beta1", - "protoPackage": "google.cloud.speech.v1p1beta1", - "schema": "1.0", - "services": { - "Adaptation": { - "clients": { - "grpc": { - "libraryClient": "AdaptationClient", - "rpcs": { - "CreateCustomClass": { - "methods": [ - "create_custom_class" - ] - }, - "CreatePhraseSet": { - "methods": [ - "create_phrase_set" - ] - }, - "DeleteCustomClass": { - "methods": [ - "delete_custom_class" - ] - }, - "DeletePhraseSet": { - "methods": [ - "delete_phrase_set" - ] - }, - "GetCustomClass": { - "methods": [ - "get_custom_class" - ] - }, - "GetPhraseSet": { - "methods": [ - "get_phrase_set" - ] - }, - "ListCustomClasses": { - "methods": [ - "list_custom_classes" - ] - }, - "ListPhraseSet": { - "methods": [ - "list_phrase_set" - ] - }, - "UpdateCustomClass": { - "methods": [ - "update_custom_class" - ] - }, - "UpdatePhraseSet": { - "methods": [ - "update_phrase_set" - ] - } - } - }, - "grpc-async": { - "libraryClient": "AdaptationAsyncClient", - "rpcs": { - "CreateCustomClass": { - "methods": [ - "create_custom_class" - ] - }, - "CreatePhraseSet": { - "methods": [ - "create_phrase_set" - ] - }, - "DeleteCustomClass": { - "methods": [ - "delete_custom_class" - ] - }, - "DeletePhraseSet": { - "methods": [ - "delete_phrase_set" - ] - }, - "GetCustomClass": { - "methods": [ - "get_custom_class" - ] - }, - "GetPhraseSet": { - "methods": [ - "get_phrase_set" - ] - }, - "ListCustomClasses": { - "methods": [ - "list_custom_classes" - ] - }, - "ListPhraseSet": { - "methods": [ - "list_phrase_set" - ] - }, - "UpdateCustomClass": { - "methods": [ - "update_custom_class" - ] - }, - "UpdatePhraseSet": { - "methods": [ - "update_phrase_set" - ] - } - } - } - } - }, - "Speech": { - "clients": { - "grpc": { - "libraryClient": "SpeechClient", - "rpcs": { - "LongRunningRecognize": { - "methods": [ - "long_running_recognize" - ] - }, - "Recognize": { - "methods": [ - "recognize" - ] - }, - "StreamingRecognize": { - "methods": [ - "streaming_recognize" - ] - } - } - }, - "grpc-async": { - "libraryClient": "SpeechAsyncClient", - "rpcs": { - "LongRunningRecognize": { - "methods": [ - "long_running_recognize" - ] - }, - "Recognize": { - "methods": [ - "recognize" - ] - }, - "StreamingRecognize": { - "methods": [ - "streaming_recognize" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed deleted file mode 100644 index 02081c09..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-speech package uses inline types. diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py deleted file mode 100644 index 4de65971..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/__init__.py +++ /dev/null @@ -1,15 +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 -# -# 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/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py deleted file mode 100644 index aa3e46a9..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/__init__.py +++ /dev/null @@ -1,22 +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 -# -# 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 AdaptationClient -from .async_client import AdaptationAsyncClient - -__all__ = ( - 'AdaptationClient', - 'AdaptationAsyncClient', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py deleted file mode 100644 index 7ac601ef..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/async_client.py +++ /dev/null @@ -1,1015 +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 -# -# 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, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.speech_v1p1beta1.services.adaptation import pagers -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import field_mask_pb2 # type: ignore -from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport -from .client import AdaptationClient - - -class AdaptationAsyncClient: - """Service that implements Google Cloud Speech Adaptation API.""" - - _client: AdaptationClient - - DEFAULT_ENDPOINT = AdaptationClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = AdaptationClient.DEFAULT_MTLS_ENDPOINT - - custom_class_path = staticmethod(AdaptationClient.custom_class_path) - parse_custom_class_path = staticmethod(AdaptationClient.parse_custom_class_path) - phrase_set_path = staticmethod(AdaptationClient.phrase_set_path) - parse_phrase_set_path = staticmethod(AdaptationClient.parse_phrase_set_path) - common_billing_account_path = staticmethod(AdaptationClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(AdaptationClient.parse_common_billing_account_path) - common_folder_path = staticmethod(AdaptationClient.common_folder_path) - parse_common_folder_path = staticmethod(AdaptationClient.parse_common_folder_path) - common_organization_path = staticmethod(AdaptationClient.common_organization_path) - parse_common_organization_path = staticmethod(AdaptationClient.parse_common_organization_path) - common_project_path = staticmethod(AdaptationClient.common_project_path) - parse_common_project_path = staticmethod(AdaptationClient.parse_common_project_path) - common_location_path = staticmethod(AdaptationClient.common_location_path) - parse_common_location_path = staticmethod(AdaptationClient.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: - AdaptationAsyncClient: The constructed client. - """ - return AdaptationClient.from_service_account_info.__func__(AdaptationAsyncClient, 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: - AdaptationAsyncClient: The constructed client. - """ - return AdaptationClient.from_service_account_file.__func__(AdaptationAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> AdaptationTransport: - """Returns the transport used by the client instance. - - Returns: - AdaptationTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(AdaptationClient).get_transport_class, type(AdaptationClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, AdaptationTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the adaptation 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, ~.AdaptationTransport]): 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 = AdaptationClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_phrase_set(self, - request: cloud_speech_adaptation.CreatePhraseSetRequest = None, - *, - parent: str = None, - phrase_set: resource.PhraseSet = None, - phrase_set_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Create a set of phrase hints. Each item in the set - can be a single word or a multi-word phrase. The items - in the PhraseSet are favored by the recognition model - when you send a call that includes the PhraseSet. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest`): - The request object. Message sent by the client for the - `CreatePhraseSet` method. - parent (:class:`str`): - Required. The parent resource where this phrase set will - be created. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): - Required. The phrase set to create. - This corresponds to the ``phrase_set`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - phrase_set_id (:class:`str`): - The ID to use for the phrase set, which will become the - final component of the phrase set's resource name. - - This value should be 4-63 characters, and valid - characters are /[a-z][0-9]-/. - - This corresponds to the ``phrase_set_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity 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, phrase_set, phrase_set_id]) - 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 = cloud_speech_adaptation.CreatePhraseSetRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if phrase_set is not None: - request.phrase_set = phrase_set - if phrase_set_id is not None: - request.phrase_set_id = phrase_set_id - - # 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_phrase_set, - default_timeout=None, - 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_phrase_set(self, - request: cloud_speech_adaptation.GetPhraseSetRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Get a phrase set. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest`): - The request object. Message sent by the client for the - `GetPhraseSet` method. - name (:class:`str`): - Required. The name of the phrase set to retrieve. - Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - 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.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set, - default_timeout=None, - 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 list_phrase_set(self, - request: cloud_speech_adaptation.ListPhraseSetRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListPhraseSetAsyncPager: - r"""List phrase sets. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest`): - The request object. Message sent by the client for the - `ListPhraseSet` method. - parent (:class:`str`): - Required. The parent, which owns this - collection of phrase set. Format: - projects/{project}/locations/{location} - - 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.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetAsyncPager: - Message returned to the client by the ListPhraseSet - method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.ListPhraseSetRequest(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_phrase_set, - default_timeout=None, - 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.ListPhraseSetAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_phrase_set(self, - request: cloud_speech_adaptation.UpdatePhraseSetRequest = None, - *, - phrase_set: resource.PhraseSet = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Update a phrase set. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest`): - The request object. Message sent by the client for the - `UpdatePhraseSet` method. - phrase_set (:class:`google.cloud.speech_v1p1beta1.types.PhraseSet`): - Required. The phrase set to update. - - The phrase set's ``name`` field is used to identify the - set to be updated. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - This corresponds to the ``phrase_set`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - The list of fields to be updated. - This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([phrase_set, update_mask]) - 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 = cloud_speech_adaptation.UpdatePhraseSetRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if phrase_set is not None: - request.phrase_set = phrase_set - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_phrase_set, - default_timeout=None, - 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(( - ("phrase_set.name", request.phrase_set.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_phrase_set(self, - request: cloud_speech_adaptation.DeletePhraseSetRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Delete a phrase set. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest`): - The request object. Message sent by the client for the - `DeletePhraseSet` method. - name (:class:`str`): - Required. The name of the phrase set to delete. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - 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. - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.DeletePhraseSetRequest(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_phrase_set, - default_timeout=None, - 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. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def create_custom_class(self, - request: cloud_speech_adaptation.CreateCustomClassRequest = None, - *, - parent: str = None, - custom_class: resource.CustomClass = None, - custom_class_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Create a custom class. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest`): - The request object. Message sent by the client for the - `CreateCustomClass` method. - parent (:class:`str`): - Required. The parent resource where this custom class - will be created. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): - Required. The custom class to create. - This corresponds to the ``custom_class`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - custom_class_id (:class:`str`): - The ID to use for the custom class, which will become - the final component of the custom class' resource name. - - This value should be 4-63 characters, and valid - characters are /[a-z][0-9]-/. - - This corresponds to the ``custom_class_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity 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, custom_class, custom_class_id]) - 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 = cloud_speech_adaptation.CreateCustomClassRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if custom_class is not None: - request.custom_class = custom_class - if custom_class_id is not None: - request.custom_class_id = custom_class_id - - # 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_custom_class, - default_timeout=None, - 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_custom_class(self, - request: cloud_speech_adaptation.GetCustomClassRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Get a custom class. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.GetCustomClassRequest`): - The request object. Message sent by the client for the - `GetCustomClass` method. - name (:class:`str`): - Required. The name of the custom class to retrieve. - Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - 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.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class, - default_timeout=None, - 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 list_custom_classes(self, - request: cloud_speech_adaptation.ListCustomClassesRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListCustomClassesAsyncPager: - r"""List custom classes. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest`): - The request object. Message sent by the client for the - `ListCustomClasses` method. - parent (:class:`str`): - Required. The parent, which owns this collection of - custom classes. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - - 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.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesAsyncPager: - Message returned to the client by the ListCustomClasses - method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.ListCustomClassesRequest(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_custom_classes, - default_timeout=None, - 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.ListCustomClassesAsyncPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_custom_class(self, - request: cloud_speech_adaptation.UpdateCustomClassRequest = None, - *, - custom_class: resource.CustomClass = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Update a custom class. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest`): - The request object. Message sent by the client for the - `UpdateCustomClass` method. - custom_class (:class:`google.cloud.speech_v1p1beta1.types.CustomClass`): - Required. The custom class to update. - - The custom class's ``name`` field is used to identify - the custom class to be updated. Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - This corresponds to the ``custom_class`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - The list of fields to be updated. - This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([custom_class, update_mask]) - 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 = cloud_speech_adaptation.UpdateCustomClassRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if custom_class is not None: - request.custom_class = custom_class - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_custom_class, - default_timeout=None, - 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(( - ("custom_class.name", request.custom_class.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_custom_class(self, - request: cloud_speech_adaptation.DeleteCustomClassRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Delete a custom class. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest`): - The request object. Message sent by the client for the - `DeleteCustomClass` method. - name (:class:`str`): - Required. The name of the custom class to delete. - Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - 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. - """ - # Create or coerce a protobuf request object. - # Sanity 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 = cloud_speech_adaptation.DeleteCustomClassRequest(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_custom_class, - default_timeout=None, - 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. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "AdaptationAsyncClient", -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py deleted file mode 100644 index 48386647..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/client.py +++ /dev/null @@ -1,1211 +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 -# -# 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 distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.speech_v1p1beta1.services.adaptation import pagers -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import field_mask_pb2 # type: ignore -from .transports.base import AdaptationTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import AdaptationGrpcTransport -from .transports.grpc_asyncio import AdaptationGrpcAsyncIOTransport - - -class AdaptationClientMeta(type): - """Metaclass for the Adaptation 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[AdaptationTransport]] - _transport_registry["grpc"] = AdaptationGrpcTransport - _transport_registry["grpc_asyncio"] = AdaptationGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[AdaptationTransport]: - """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 AdaptationClient(metaclass=AdaptationClientMeta): - """Service that implements Google Cloud Speech Adaptation API.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "speech.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: - AdaptationClient: 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: - AdaptationClient: 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) -> AdaptationTransport: - """Returns the transport used by the client instance. - - Returns: - AdaptationTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def custom_class_path(project: str,location: str,custom_class: str,) -> str: - """Returns a fully-qualified custom_class string.""" - return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) - - @staticmethod - def parse_custom_class_path(path: str) -> Dict[str,str]: - """Parses a custom_class path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: - """Returns a fully-qualified phrase_set string.""" - return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) - - @staticmethod - def parse_phrase_set_path(path: str) -> Dict[str,str]: - """Parses a phrase_set path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?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 {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, AdaptationTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the adaptation 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, AdaptationTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.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. - 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() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # 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, AdaptationTransport): - # transport is a AdaptationTransport instance. - if credentials or client_options.credentials_file: - 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: - 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, - ) - - def create_phrase_set(self, - request: cloud_speech_adaptation.CreatePhraseSetRequest = None, - *, - parent: str = None, - phrase_set: resource.PhraseSet = None, - phrase_set_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Create a set of phrase hints. Each item in the set - can be a single word or a multi-word phrase. The items - in the PhraseSet are favored by the recognition model - when you send a call that includes the PhraseSet. - - Args: - request (google.cloud.speech_v1p1beta1.types.CreatePhraseSetRequest): - The request object. Message sent by the client for the - `CreatePhraseSet` method. - parent (str): - Required. The parent resource where this phrase set will - be created. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): - Required. The phrase set to create. - This corresponds to the ``phrase_set`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - phrase_set_id (str): - The ID to use for the phrase set, which will become the - final component of the phrase set's resource name. - - This value should be 4-63 characters, and valid - characters are /[a-z][0-9]-/. - - This corresponds to the ``phrase_set_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity 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, phrase_set, phrase_set_id]) - 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 cloud_speech_adaptation.CreatePhraseSetRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.CreatePhraseSetRequest): - request = cloud_speech_adaptation.CreatePhraseSetRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if phrase_set is not None: - request.phrase_set = phrase_set - if phrase_set_id is not None: - request.phrase_set_id = phrase_set_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_phrase_set] - - # 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_phrase_set(self, - request: cloud_speech_adaptation.GetPhraseSetRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Get a phrase set. - - Args: - request (google.cloud.speech_v1p1beta1.types.GetPhraseSetRequest): - The request object. Message sent by the client for the - `GetPhraseSet` method. - name (str): - Required. The name of the phrase set to retrieve. - Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - 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.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.GetPhraseSetRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.GetPhraseSetRequest): - request = cloud_speech_adaptation.GetPhraseSetRequest(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_phrase_set] - - # 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 list_phrase_set(self, - request: cloud_speech_adaptation.ListPhraseSetRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListPhraseSetPager: - r"""List phrase sets. - - Args: - request (google.cloud.speech_v1p1beta1.types.ListPhraseSetRequest): - The request object. Message sent by the client for the - `ListPhraseSet` method. - parent (str): - Required. The parent, which owns this - collection of phrase set. Format: - projects/{project}/locations/{location} - - 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.speech_v1p1beta1.services.adaptation.pagers.ListPhraseSetPager: - Message returned to the client by the ListPhraseSet - method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.ListPhraseSetRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.ListPhraseSetRequest): - request = cloud_speech_adaptation.ListPhraseSetRequest(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_phrase_set] - - # 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.ListPhraseSetPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_phrase_set(self, - request: cloud_speech_adaptation.UpdatePhraseSetRequest = None, - *, - phrase_set: resource.PhraseSet = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.PhraseSet: - r"""Update a phrase set. - - Args: - request (google.cloud.speech_v1p1beta1.types.UpdatePhraseSetRequest): - The request object. Message sent by the client for the - `UpdatePhraseSet` method. - phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): - Required. The phrase set to update. - - The phrase set's ``name`` field is used to identify the - set to be updated. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - This corresponds to the ``phrase_set`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be updated. - This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.PhraseSet: - Provides "hints" to the speech - recognizer to favor specific words and - phrases in the results. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([phrase_set, update_mask]) - 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 cloud_speech_adaptation.UpdatePhraseSetRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.UpdatePhraseSetRequest): - request = cloud_speech_adaptation.UpdatePhraseSetRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if phrase_set is not None: - request.phrase_set = phrase_set - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_phrase_set] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("phrase_set.name", request.phrase_set.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_phrase_set(self, - request: cloud_speech_adaptation.DeletePhraseSetRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Delete a phrase set. - - Args: - request (google.cloud.speech_v1p1beta1.types.DeletePhraseSetRequest): - The request object. Message sent by the client for the - `DeletePhraseSet` method. - name (str): - Required. The name of the phrase set to delete. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - - 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. - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.DeletePhraseSetRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.DeletePhraseSetRequest): - request = cloud_speech_adaptation.DeletePhraseSetRequest(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_phrase_set] - - # 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. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def create_custom_class(self, - request: cloud_speech_adaptation.CreateCustomClassRequest = None, - *, - parent: str = None, - custom_class: resource.CustomClass = None, - custom_class_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Create a custom class. - - Args: - request (google.cloud.speech_v1p1beta1.types.CreateCustomClassRequest): - The request object. Message sent by the client for the - `CreateCustomClass` method. - parent (str): - Required. The parent resource where this custom class - will be created. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): - Required. The custom class to create. - This corresponds to the ``custom_class`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - custom_class_id (str): - The ID to use for the custom class, which will become - the final component of the custom class' resource name. - - This value should be 4-63 characters, and valid - characters are /[a-z][0-9]-/. - - This corresponds to the ``custom_class_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity 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, custom_class, custom_class_id]) - 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 cloud_speech_adaptation.CreateCustomClassRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.CreateCustomClassRequest): - request = cloud_speech_adaptation.CreateCustomClassRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if custom_class is not None: - request.custom_class = custom_class - if custom_class_id is not None: - request.custom_class_id = custom_class_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_custom_class] - - # 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_custom_class(self, - request: cloud_speech_adaptation.GetCustomClassRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Get a custom class. - - Args: - request (google.cloud.speech_v1p1beta1.types.GetCustomClassRequest): - The request object. Message sent by the client for the - `GetCustomClass` method. - name (str): - Required. The name of the custom class to retrieve. - Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - 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.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.GetCustomClassRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.GetCustomClassRequest): - request = cloud_speech_adaptation.GetCustomClassRequest(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_custom_class] - - # 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 list_custom_classes(self, - request: cloud_speech_adaptation.ListCustomClassesRequest = None, - *, - parent: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> pagers.ListCustomClassesPager: - r"""List custom classes. - - Args: - request (google.cloud.speech_v1p1beta1.types.ListCustomClassesRequest): - The request object. Message sent by the client for the - `ListCustomClasses` method. - parent (str): - Required. The parent, which owns this collection of - custom classes. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - - 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.speech_v1p1beta1.services.adaptation.pagers.ListCustomClassesPager: - Message returned to the client by the ListCustomClasses - method. - - Iterating over this object will yield results and - resolve additional pages automatically. - - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.ListCustomClassesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.ListCustomClassesRequest): - request = cloud_speech_adaptation.ListCustomClassesRequest(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_custom_classes] - - # 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.ListCustomClassesPager( - method=rpc, - request=request, - response=response, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_custom_class(self, - request: cloud_speech_adaptation.UpdateCustomClassRequest = None, - *, - custom_class: resource.CustomClass = None, - update_mask: field_mask_pb2.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> resource.CustomClass: - r"""Update a custom class. - - Args: - request (google.cloud.speech_v1p1beta1.types.UpdateCustomClassRequest): - The request object. Message sent by the client for the - `UpdateCustomClass` method. - custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): - Required. The custom class to update. - - The custom class's ``name`` field is used to identify - the custom class to be updated. Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - This corresponds to the ``custom_class`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be updated. - This corresponds to the ``update_mask`` 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.speech_v1p1beta1.types.CustomClass: - A set of words or phrases that - represents a common concept likely to - appear in your audio, for example a list - of passenger ship names. CustomClass - items can be substituted into - placeholders that you set in PhraseSet - phrases. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([custom_class, update_mask]) - 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 cloud_speech_adaptation.UpdateCustomClassRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.UpdateCustomClassRequest): - request = cloud_speech_adaptation.UpdateCustomClassRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if custom_class is not None: - request.custom_class = custom_class - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_custom_class] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("custom_class.name", request.custom_class.name), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_custom_class(self, - request: cloud_speech_adaptation.DeleteCustomClassRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Delete a custom class. - - Args: - request (google.cloud.speech_v1p1beta1.types.DeleteCustomClassRequest): - The request object. Message sent by the client for the - `DeleteCustomClass` method. - name (str): - Required. The name of the custom class to delete. - Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - - 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. - """ - # Create or coerce a protobuf request object. - # Sanity 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 cloud_speech_adaptation.DeleteCustomClassRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech_adaptation.DeleteCustomClassRequest): - request = cloud_speech_adaptation.DeleteCustomClassRequest(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_custom_class] - - # 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. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "AdaptationClient", -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py deleted file mode 100644 index b89b1ec5..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/pagers.py +++ /dev/null @@ -1,263 +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 -# -# 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, AsyncIterable, Awaitable, Callable, Iterable, Sequence, Tuple, Optional - -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource - - -class ListPhraseSetPager: - """A pager for iterating through ``list_phrase_set`` requests. - - This class thinly wraps an initial - :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and - provides an ``__iter__`` method to iterate through its - ``phrase_sets`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListPhraseSet`` requests and continue to iterate - through the ``phrase_sets`` field on the - corresponding responses. - - All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` - 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[..., cloud_speech_adaptation.ListPhraseSetResponse], - request: cloud_speech_adaptation.ListPhraseSetRequest, - response: cloud_speech_adaptation.ListPhraseSetResponse, - *, - 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.speech_v1p1beta1.types.ListPhraseSetRequest): - The initial request object. - response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): - 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 = cloud_speech_adaptation.ListPhraseSetRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[cloud_speech_adaptation.ListPhraseSetResponse]: - 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) -> Iterable[resource.PhraseSet]: - for page in self.pages: - yield from page.phrase_sets - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListPhraseSetAsyncPager: - """A pager for iterating through ``list_phrase_set`` requests. - - This class thinly wraps an initial - :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``phrase_sets`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListPhraseSet`` requests and continue to iterate - through the ``phrase_sets`` field on the - corresponding responses. - - All the usual :class:`google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse` - 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[cloud_speech_adaptation.ListPhraseSetResponse]], - request: cloud_speech_adaptation.ListPhraseSetRequest, - response: cloud_speech_adaptation.ListPhraseSetResponse, - *, - 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.speech_v1p1beta1.types.ListPhraseSetRequest): - The initial request object. - response (google.cloud.speech_v1p1beta1.types.ListPhraseSetResponse): - 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 = cloud_speech_adaptation.ListPhraseSetRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[cloud_speech_adaptation.ListPhraseSetResponse]: - 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) -> AsyncIterable[resource.PhraseSet]: - async def async_generator(): - async for page in self.pages: - for response in page.phrase_sets: - yield response - - return async_generator() - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCustomClassesPager: - """A pager for iterating through ``list_custom_classes`` requests. - - This class thinly wraps an initial - :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and - provides an ``__iter__`` method to iterate through its - ``custom_classes`` field. - - If there are more pages, the ``__iter__`` method will make additional - ``ListCustomClasses`` requests and continue to iterate - through the ``custom_classes`` field on the - corresponding responses. - - All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` - 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[..., cloud_speech_adaptation.ListCustomClassesResponse], - request: cloud_speech_adaptation.ListCustomClassesRequest, - response: cloud_speech_adaptation.ListCustomClassesResponse, - *, - 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.speech_v1p1beta1.types.ListCustomClassesRequest): - The initial request object. - response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): - 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 = cloud_speech_adaptation.ListCustomClassesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - def pages(self) -> Iterable[cloud_speech_adaptation.ListCustomClassesResponse]: - 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) -> Iterable[resource.CustomClass]: - for page in self.pages: - yield from page.custom_classes - - def __repr__(self) -> str: - return '{0}<{1!r}>'.format(self.__class__.__name__, self._response) - - -class ListCustomClassesAsyncPager: - """A pager for iterating through ``list_custom_classes`` requests. - - This class thinly wraps an initial - :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` object, and - provides an ``__aiter__`` method to iterate through its - ``custom_classes`` field. - - If there are more pages, the ``__aiter__`` method will make additional - ``ListCustomClasses`` requests and continue to iterate - through the ``custom_classes`` field on the - corresponding responses. - - All the usual :class:`google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse` - 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[cloud_speech_adaptation.ListCustomClassesResponse]], - request: cloud_speech_adaptation.ListCustomClassesRequest, - response: cloud_speech_adaptation.ListCustomClassesResponse, - *, - 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.speech_v1p1beta1.types.ListCustomClassesRequest): - The initial request object. - response (google.cloud.speech_v1p1beta1.types.ListCustomClassesResponse): - 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 = cloud_speech_adaptation.ListCustomClassesRequest(request) - self._response = response - self._metadata = metadata - - def __getattr__(self, name: str) -> Any: - return getattr(self._response, name) - - @property - async def pages(self) -> AsyncIterable[cloud_speech_adaptation.ListCustomClassesResponse]: - 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) -> AsyncIterable[resource.CustomClass]: - async def async_generator(): - async for page in self.pages: - for response in page.custom_classes: - 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/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py deleted file mode 100644 index d8329c94..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/__init__.py +++ /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 -# -# 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 AdaptationTransport -from .grpc import AdaptationGrpcTransport -from .grpc_asyncio import AdaptationGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[AdaptationTransport]] -_transport_registry['grpc'] = AdaptationGrpcTransport -_transport_registry['grpc_asyncio'] = AdaptationGrpcAsyncIOTransport - -__all__ = ( - 'AdaptationTransport', - 'AdaptationGrpcTransport', - 'AdaptationGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py deleted file mode 100644 index 58b668a8..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/base.py +++ /dev/null @@ -1,296 +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 -# -# 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 -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import empty_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-speech', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class AdaptationTransport(abc.ABC): - """Abstract transport class for Adaptation.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'speech.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: 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, - **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. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes or self.AUTH_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) - - # If the credentials is 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 - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_phrase_set: gapic_v1.method.wrap_method( - self.create_phrase_set, - default_timeout=None, - client_info=client_info, - ), - self.get_phrase_set: gapic_v1.method.wrap_method( - self.get_phrase_set, - default_timeout=None, - client_info=client_info, - ), - self.list_phrase_set: gapic_v1.method.wrap_method( - self.list_phrase_set, - default_timeout=None, - client_info=client_info, - ), - self.update_phrase_set: gapic_v1.method.wrap_method( - self.update_phrase_set, - default_timeout=None, - client_info=client_info, - ), - self.delete_phrase_set: gapic_v1.method.wrap_method( - self.delete_phrase_set, - default_timeout=None, - client_info=client_info, - ), - self.create_custom_class: gapic_v1.method.wrap_method( - self.create_custom_class, - default_timeout=None, - client_info=client_info, - ), - self.get_custom_class: gapic_v1.method.wrap_method( - self.get_custom_class, - default_timeout=None, - client_info=client_info, - ), - self.list_custom_classes: gapic_v1.method.wrap_method( - self.list_custom_classes, - default_timeout=None, - client_info=client_info, - ), - self.update_custom_class: gapic_v1.method.wrap_method( - self.update_custom_class, - default_timeout=None, - client_info=client_info, - ), - self.delete_custom_class: gapic_v1.method.wrap_method( - self.delete_custom_class, - default_timeout=None, - client_info=client_info, - ), - } - - @property - def create_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.CreatePhraseSetRequest], - Union[ - resource.PhraseSet, - Awaitable[resource.PhraseSet] - ]]: - raise NotImplementedError() - - @property - def get_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.GetPhraseSetRequest], - Union[ - resource.PhraseSet, - Awaitable[resource.PhraseSet] - ]]: - raise NotImplementedError() - - @property - def list_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.ListPhraseSetRequest], - Union[ - cloud_speech_adaptation.ListPhraseSetResponse, - Awaitable[cloud_speech_adaptation.ListPhraseSetResponse] - ]]: - raise NotImplementedError() - - @property - def update_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.UpdatePhraseSetRequest], - Union[ - resource.PhraseSet, - Awaitable[resource.PhraseSet] - ]]: - raise NotImplementedError() - - @property - def delete_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.DeletePhraseSetRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def create_custom_class(self) -> Callable[ - [cloud_speech_adaptation.CreateCustomClassRequest], - Union[ - resource.CustomClass, - Awaitable[resource.CustomClass] - ]]: - raise NotImplementedError() - - @property - def get_custom_class(self) -> Callable[ - [cloud_speech_adaptation.GetCustomClassRequest], - Union[ - resource.CustomClass, - Awaitable[resource.CustomClass] - ]]: - raise NotImplementedError() - - @property - def list_custom_classes(self) -> Callable[ - [cloud_speech_adaptation.ListCustomClassesRequest], - Union[ - cloud_speech_adaptation.ListCustomClassesResponse, - Awaitable[cloud_speech_adaptation.ListCustomClassesResponse] - ]]: - raise NotImplementedError() - - @property - def update_custom_class(self) -> Callable[ - [cloud_speech_adaptation.UpdateCustomClassRequest], - Union[ - resource.CustomClass, - Awaitable[resource.CustomClass] - ]]: - raise NotImplementedError() - - @property - def delete_custom_class(self) -> Callable[ - [cloud_speech_adaptation.DeleteCustomClassRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'AdaptationTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py deleted file mode 100644 index 45fb4a3b..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc.py +++ /dev/null @@ -1,488 +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 -# -# 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 # type: ignore -from google.api_core import gapic_v1 # type: ignore -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.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import empty_pb2 # type: ignore -from .base import AdaptationTransport, DEFAULT_CLIENT_INFO - - -class AdaptationGrpcTransport(AdaptationTransport): - """gRPC backend transport for Adaptation. - - Service that implements Google Cloud Speech Adaptation API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def create_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.CreatePhraseSetRequest], - resource.PhraseSet]: - r"""Return a callable for the create phrase set method over gRPC. - - Create a set of phrase hints. Each item in the set - can be a single word or a multi-word phrase. The items - in the PhraseSet are favored by the recognition model - when you send a call that includes the PhraseSet. - - Returns: - Callable[[~.CreatePhraseSetRequest], - ~.PhraseSet]: - 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_phrase_set' not in self._stubs: - self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', - request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['create_phrase_set'] - - @property - def get_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.GetPhraseSetRequest], - resource.PhraseSet]: - r"""Return a callable for the get phrase set method over gRPC. - - Get a phrase set. - - Returns: - Callable[[~.GetPhraseSetRequest], - ~.PhraseSet]: - 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_phrase_set' not in self._stubs: - self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', - request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['get_phrase_set'] - - @property - def list_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.ListPhraseSetRequest], - cloud_speech_adaptation.ListPhraseSetResponse]: - r"""Return a callable for the list phrase set method over gRPC. - - List phrase sets. - - Returns: - Callable[[~.ListPhraseSetRequest], - ~.ListPhraseSetResponse]: - 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_phrase_set' not in self._stubs: - self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', - request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, - response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, - ) - return self._stubs['list_phrase_set'] - - @property - def update_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.UpdatePhraseSetRequest], - resource.PhraseSet]: - r"""Return a callable for the update phrase set method over gRPC. - - Update a phrase set. - - Returns: - Callable[[~.UpdatePhraseSetRequest], - ~.PhraseSet]: - 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 'update_phrase_set' not in self._stubs: - self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', - request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['update_phrase_set'] - - @property - def delete_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.DeletePhraseSetRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete phrase set method over gRPC. - - Delete a phrase set. - - Returns: - Callable[[~.DeletePhraseSetRequest], - ~.Empty]: - 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_phrase_set' not in self._stubs: - self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', - request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_phrase_set'] - - @property - def create_custom_class(self) -> Callable[ - [cloud_speech_adaptation.CreateCustomClassRequest], - resource.CustomClass]: - r"""Return a callable for the create custom class method over gRPC. - - Create a custom class. - - Returns: - Callable[[~.CreateCustomClassRequest], - ~.CustomClass]: - 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_custom_class' not in self._stubs: - self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', - request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['create_custom_class'] - - @property - def get_custom_class(self) -> Callable[ - [cloud_speech_adaptation.GetCustomClassRequest], - resource.CustomClass]: - r"""Return a callable for the get custom class method over gRPC. - - Get a custom class. - - Returns: - Callable[[~.GetCustomClassRequest], - ~.CustomClass]: - 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_custom_class' not in self._stubs: - self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', - request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['get_custom_class'] - - @property - def list_custom_classes(self) -> Callable[ - [cloud_speech_adaptation.ListCustomClassesRequest], - cloud_speech_adaptation.ListCustomClassesResponse]: - r"""Return a callable for the list custom classes method over gRPC. - - List custom classes. - - Returns: - Callable[[~.ListCustomClassesRequest], - ~.ListCustomClassesResponse]: - 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_custom_classes' not in self._stubs: - self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', - request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, - response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, - ) - return self._stubs['list_custom_classes'] - - @property - def update_custom_class(self) -> Callable[ - [cloud_speech_adaptation.UpdateCustomClassRequest], - resource.CustomClass]: - r"""Return a callable for the update custom class method over gRPC. - - Update a custom class. - - Returns: - Callable[[~.UpdateCustomClassRequest], - ~.CustomClass]: - 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 'update_custom_class' not in self._stubs: - self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', - request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['update_custom_class'] - - @property - def delete_custom_class(self) -> Callable[ - [cloud_speech_adaptation.DeleteCustomClassRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete custom class method over gRPC. - - Delete a custom class. - - Returns: - Callable[[~.DeleteCustomClassRequest], - ~.Empty]: - 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_custom_class' not in self._stubs: - self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', - request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_custom_class'] - - -__all__ = ( - 'AdaptationGrpcTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py deleted file mode 100644 index eeddd3f0..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/adaptation/transports/grpc_asyncio.py +++ /dev/null @@ -1,492 +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 -# -# 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 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import empty_pb2 # type: ignore -from .base import AdaptationTransport, DEFAULT_CLIENT_INFO -from .grpc import AdaptationGrpcTransport - - -class AdaptationGrpcAsyncIOTransport(AdaptationTransport): - """gRPC AsyncIO backend transport for Adaptation. - - Service that implements Google Cloud Speech Adaptation API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'speech.googleapis.com', - credentials: 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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 create_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.CreatePhraseSetRequest], - Awaitable[resource.PhraseSet]]: - r"""Return a callable for the create phrase set method over gRPC. - - Create a set of phrase hints. Each item in the set - can be a single word or a multi-word phrase. The items - in the PhraseSet are favored by the recognition model - when you send a call that includes the PhraseSet. - - Returns: - Callable[[~.CreatePhraseSetRequest], - Awaitable[~.PhraseSet]]: - 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_phrase_set' not in self._stubs: - self._stubs['create_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/CreatePhraseSet', - request_serializer=cloud_speech_adaptation.CreatePhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['create_phrase_set'] - - @property - def get_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.GetPhraseSetRequest], - Awaitable[resource.PhraseSet]]: - r"""Return a callable for the get phrase set method over gRPC. - - Get a phrase set. - - Returns: - Callable[[~.GetPhraseSetRequest], - Awaitable[~.PhraseSet]]: - 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_phrase_set' not in self._stubs: - self._stubs['get_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/GetPhraseSet', - request_serializer=cloud_speech_adaptation.GetPhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['get_phrase_set'] - - @property - def list_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.ListPhraseSetRequest], - Awaitable[cloud_speech_adaptation.ListPhraseSetResponse]]: - r"""Return a callable for the list phrase set method over gRPC. - - List phrase sets. - - Returns: - Callable[[~.ListPhraseSetRequest], - Awaitable[~.ListPhraseSetResponse]]: - 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_phrase_set' not in self._stubs: - self._stubs['list_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/ListPhraseSet', - request_serializer=cloud_speech_adaptation.ListPhraseSetRequest.serialize, - response_deserializer=cloud_speech_adaptation.ListPhraseSetResponse.deserialize, - ) - return self._stubs['list_phrase_set'] - - @property - def update_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.UpdatePhraseSetRequest], - Awaitable[resource.PhraseSet]]: - r"""Return a callable for the update phrase set method over gRPC. - - Update a phrase set. - - Returns: - Callable[[~.UpdatePhraseSetRequest], - Awaitable[~.PhraseSet]]: - 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 'update_phrase_set' not in self._stubs: - self._stubs['update_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/UpdatePhraseSet', - request_serializer=cloud_speech_adaptation.UpdatePhraseSetRequest.serialize, - response_deserializer=resource.PhraseSet.deserialize, - ) - return self._stubs['update_phrase_set'] - - @property - def delete_phrase_set(self) -> Callable[ - [cloud_speech_adaptation.DeletePhraseSetRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete phrase set method over gRPC. - - Delete a phrase set. - - Returns: - Callable[[~.DeletePhraseSetRequest], - Awaitable[~.Empty]]: - 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_phrase_set' not in self._stubs: - self._stubs['delete_phrase_set'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/DeletePhraseSet', - request_serializer=cloud_speech_adaptation.DeletePhraseSetRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_phrase_set'] - - @property - def create_custom_class(self) -> Callable[ - [cloud_speech_adaptation.CreateCustomClassRequest], - Awaitable[resource.CustomClass]]: - r"""Return a callable for the create custom class method over gRPC. - - Create a custom class. - - Returns: - Callable[[~.CreateCustomClassRequest], - Awaitable[~.CustomClass]]: - 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_custom_class' not in self._stubs: - self._stubs['create_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/CreateCustomClass', - request_serializer=cloud_speech_adaptation.CreateCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['create_custom_class'] - - @property - def get_custom_class(self) -> Callable[ - [cloud_speech_adaptation.GetCustomClassRequest], - Awaitable[resource.CustomClass]]: - r"""Return a callable for the get custom class method over gRPC. - - Get a custom class. - - Returns: - Callable[[~.GetCustomClassRequest], - Awaitable[~.CustomClass]]: - 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_custom_class' not in self._stubs: - self._stubs['get_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/GetCustomClass', - request_serializer=cloud_speech_adaptation.GetCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['get_custom_class'] - - @property - def list_custom_classes(self) -> Callable[ - [cloud_speech_adaptation.ListCustomClassesRequest], - Awaitable[cloud_speech_adaptation.ListCustomClassesResponse]]: - r"""Return a callable for the list custom classes method over gRPC. - - List custom classes. - - Returns: - Callable[[~.ListCustomClassesRequest], - Awaitable[~.ListCustomClassesResponse]]: - 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_custom_classes' not in self._stubs: - self._stubs['list_custom_classes'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/ListCustomClasses', - request_serializer=cloud_speech_adaptation.ListCustomClassesRequest.serialize, - response_deserializer=cloud_speech_adaptation.ListCustomClassesResponse.deserialize, - ) - return self._stubs['list_custom_classes'] - - @property - def update_custom_class(self) -> Callable[ - [cloud_speech_adaptation.UpdateCustomClassRequest], - Awaitable[resource.CustomClass]]: - r"""Return a callable for the update custom class method over gRPC. - - Update a custom class. - - Returns: - Callable[[~.UpdateCustomClassRequest], - Awaitable[~.CustomClass]]: - 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 'update_custom_class' not in self._stubs: - self._stubs['update_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/UpdateCustomClass', - request_serializer=cloud_speech_adaptation.UpdateCustomClassRequest.serialize, - response_deserializer=resource.CustomClass.deserialize, - ) - return self._stubs['update_custom_class'] - - @property - def delete_custom_class(self) -> Callable[ - [cloud_speech_adaptation.DeleteCustomClassRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete custom class method over gRPC. - - Delete a custom class. - - Returns: - Callable[[~.DeleteCustomClassRequest], - Awaitable[~.Empty]]: - 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_custom_class' not in self._stubs: - self._stubs['delete_custom_class'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Adaptation/DeleteCustomClass', - request_serializer=cloud_speech_adaptation.DeleteCustomClassRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_custom_class'] - - -__all__ = ( - 'AdaptationGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py deleted file mode 100644 index 13e0fa86..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/__init__.py +++ /dev/null @@ -1,22 +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 -# -# 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 SpeechClient -from .async_client import SpeechAsyncClient - -__all__ = ( - 'SpeechClient', - 'SpeechAsyncClient', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py deleted file mode 100644 index 760c4353..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/async_client.py +++ /dev/null @@ -1,468 +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 -# -# 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, AsyncIterable, Awaitable, AsyncIterator, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.speech_v1p1beta1.types import cloud_speech -from google.rpc import status_pb2 # type: ignore -from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport -from .client import SpeechClient - - -class SpeechAsyncClient: - """Service that implements Google Cloud Speech API.""" - - _client: SpeechClient - - DEFAULT_ENDPOINT = SpeechClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = SpeechClient.DEFAULT_MTLS_ENDPOINT - - custom_class_path = staticmethod(SpeechClient.custom_class_path) - parse_custom_class_path = staticmethod(SpeechClient.parse_custom_class_path) - phrase_set_path = staticmethod(SpeechClient.phrase_set_path) - parse_phrase_set_path = staticmethod(SpeechClient.parse_phrase_set_path) - common_billing_account_path = staticmethod(SpeechClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(SpeechClient.parse_common_billing_account_path) - common_folder_path = staticmethod(SpeechClient.common_folder_path) - parse_common_folder_path = staticmethod(SpeechClient.parse_common_folder_path) - common_organization_path = staticmethod(SpeechClient.common_organization_path) - parse_common_organization_path = staticmethod(SpeechClient.parse_common_organization_path) - common_project_path = staticmethod(SpeechClient.common_project_path) - parse_common_project_path = staticmethod(SpeechClient.parse_common_project_path) - common_location_path = staticmethod(SpeechClient.common_location_path) - parse_common_location_path = staticmethod(SpeechClient.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: - SpeechAsyncClient: The constructed client. - """ - return SpeechClient.from_service_account_info.__func__(SpeechAsyncClient, 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: - SpeechAsyncClient: The constructed client. - """ - return SpeechClient.from_service_account_file.__func__(SpeechAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> SpeechTransport: - """Returns the transport used by the client instance. - - Returns: - SpeechTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(SpeechClient).get_transport_class, type(SpeechClient)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, SpeechTransport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the speech 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, ~.SpeechTransport]): 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 = SpeechClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def recognize(self, - request: cloud_speech.RecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_speech.RecognizeResponse: - r"""Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.RecognizeRequest`): - The request object. The top-level message sent by the - client for the `Recognize` method. - config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: - The only message returned to the client by the Recognize method. It - contains the result as zero or more sequential - SpeechRecognitionResult messages. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 = cloud_speech.RecognizeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def long_running_recognize(self, - request: cloud_speech.LongRunningRecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation_async.AsyncOperation: - r"""Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Args: - request (:class:`google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest`): - The request object. The top-level message sent by the - client for the `LongRunningRecognize` method. - config (:class:`google.cloud.speech_v1p1beta1.types.RecognitionConfig`): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (:class:`google.cloud.speech_v1p1beta1.types.RecognitionAudio`): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. - It contains the result as zero or more sequential - SpeechRecognitionResult messages. It is included in - the result.response field of the Operation returned - by the GetOperation call of the - google::longrunning::Operations service. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 = cloud_speech.LongRunningRecognizeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.long_running_recognize, - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # 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, - cloud_speech.LongRunningRecognizeResponse, - metadata_type=cloud_speech.LongRunningRecognizeMetadata, - ) - - # Done; return the response. - return response - - def streaming_recognize(self, - requests: AsyncIterator[cloud_speech.StreamingRecognizeRequest] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> Awaitable[AsyncIterable[cloud_speech.StreamingRecognizeResponse]]: - r"""Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Args: - requests (AsyncIterator[`google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest`]): - The request object AsyncIterator. The top-level message sent by the - client for the `StreamingRecognize` method. Multiple - `StreamingRecognizeRequest` messages are sent. The first - message must contain a `streaming_config` message and - must not contain `audio_content`. All subsequent - messages must contain `audio_content` and must not - contain a `streaming_config` message. - 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: - AsyncIterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: - StreamingRecognizeResponse is the only message returned to the client by - StreamingRecognize. A series of zero or more - StreamingRecognizeResponse messages are streamed back - to the client. If there is no recognizable audio, and - single_utterance is set to false, then no messages - are streamed back to the client. - - Here's an example of a series of - StreamingRecognizeResponses that might be returned - while processing audio: - - 1. results { alternatives { transcript: "tube" } - stability: 0.01 } - 2. results { alternatives { transcript: "to be a" } - stability: 0.01 } - 3. results { alternatives { transcript: "to be" } - stability: 0.9 } results { alternatives { - transcript: " or not to be" } stability: 0.01 } - 4. - - results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } - - alternatives { transcript: "to bee or not to bee" } - is_final: true } - - 5. results { alternatives { transcript: " that's" } - stability: 0.01 } - 6. results { alternatives { transcript: " that is" } - stability: 0.9 } results { alternatives { - transcript: " the question" } stability: 0.01 } - 7. - - results { alternatives { transcript: " that is the question" - confidence: 0.98 } - - alternatives { transcript: " that was the question" } - is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain - final results; they are indicated by - is_final: true. Concatenating these together - generates the full transcript: "to be or not to be - that is the question". - - The others contain interim results. #3 and #6 - contain two interim \`results`: the first portion - has a high stability and is less likely to change; - the second portion has a low stability and is very - likely to change. A UI designer might choose to - show only high stability results. - - The specific stability and confidence values shown - above are only for illustrative purposes. Actual - values may vary. - - - - In each response, only one of these fields will be set: - error, speech_event_type, or one or more - (repeated) results. - - """ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.streaming_recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = rpc( - requests, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SpeechAsyncClient", -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py deleted file mode 100644 index 69937262..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/client.py +++ /dev/null @@ -1,646 +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 -# -# 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 distutils import util -import os -import re -from typing import Callable, Dict, Optional, Iterable, Iterator, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.api_core import operation # type: ignore -from google.api_core import operation_async # type: ignore -from google.cloud.speech_v1p1beta1.types import cloud_speech -from google.rpc import status_pb2 # type: ignore -from .transports.base import SpeechTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import SpeechGrpcTransport -from .transports.grpc_asyncio import SpeechGrpcAsyncIOTransport - - -class SpeechClientMeta(type): - """Metaclass for the Speech 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[SpeechTransport]] - _transport_registry["grpc"] = SpeechGrpcTransport - _transport_registry["grpc_asyncio"] = SpeechGrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[SpeechTransport]: - """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 SpeechClient(metaclass=SpeechClientMeta): - """Service that implements Google Cloud Speech API.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "speech.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: - SpeechClient: 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: - SpeechClient: 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) -> SpeechTransport: - """Returns the transport used by the client instance. - - Returns: - SpeechTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def custom_class_path(project: str,location: str,custom_class: str,) -> str: - """Returns a fully-qualified custom_class string.""" - return "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) - - @staticmethod - def parse_custom_class_path(path: str) -> Dict[str,str]: - """Parses a custom_class path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/customClasses/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def phrase_set_path(project: str,location: str,phrase_set: str,) -> str: - """Returns a fully-qualified phrase_set string.""" - return "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) - - @staticmethod - def parse_phrase_set_path(path: str) -> Dict[str,str]: - """Parses a phrase_set path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)/phraseSets/(?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 {} - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, SpeechTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the speech 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, SpeechTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.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. - 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() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - if is_mtls: - client_cert_source_func = mtls.default_client_cert_source() - else: - client_cert_source_func = None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - if is_mtls: - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted " - "values: never, auto, always" - ) - - # 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, SpeechTransport): - # transport is a SpeechTransport instance. - if credentials or client_options.credentials_file: - 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: - 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, - ) - - def recognize(self, - request: cloud_speech.RecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> cloud_speech.RecognizeResponse: - r"""Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Args: - request (google.cloud.speech_v1p1beta1.types.RecognizeRequest): - The request object. The top-level message sent by the - client for the `Recognize` method. - config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1p1beta1.types.RecognizeResponse: - The only message returned to the client by the Recognize method. It - contains the result as zero or more sequential - SpeechRecognitionResult messages. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 cloud_speech.RecognizeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech.RecognizeRequest): - request = cloud_speech.RecognizeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.recognize] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def long_running_recognize(self, - request: cloud_speech.LongRunningRecognizeRequest = None, - *, - config: cloud_speech.RecognitionConfig = None, - audio: cloud_speech.RecognitionAudio = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> operation.Operation: - r"""Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Args: - request (google.cloud.speech_v1p1beta1.types.LongRunningRecognizeRequest): - The request object. The top-level message sent by the - client for the `LongRunningRecognize` method. - config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process - the request. - - This corresponds to the ``config`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): - Required. The audio data to be - recognized. - - This corresponds to the ``audio`` 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.speech_v1p1beta1.types.LongRunningRecognizeResponse` The only message returned to the client by the LongRunningRecognize method. - It contains the result as zero or more sequential - SpeechRecognitionResult messages. It is included in - the result.response field of the Operation returned - by the GetOperation call of the - google::longrunning::Operations service. - - """ - # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([config, audio]) - 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 cloud_speech.LongRunningRecognizeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, cloud_speech.LongRunningRecognizeRequest): - request = cloud_speech.LongRunningRecognizeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if config is not None: - request.config = config - if audio is not None: - request.audio = audio - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.long_running_recognize] - - # 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, - cloud_speech.LongRunningRecognizeResponse, - metadata_type=cloud_speech.LongRunningRecognizeMetadata, - ) - - # Done; return the response. - return response - - def streaming_recognize(self, - requests: Iterator[cloud_speech.StreamingRecognizeRequest] = None, - *, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> Iterable[cloud_speech.StreamingRecognizeResponse]: - r"""Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Args: - requests (Iterator[google.cloud.speech_v1p1beta1.types.StreamingRecognizeRequest]): - The request object iterator. The top-level message sent by the - client for the `StreamingRecognize` method. Multiple - `StreamingRecognizeRequest` messages are sent. The first - message must contain a `streaming_config` message and - must not contain `audio_content`. All subsequent - messages must contain `audio_content` and must not - contain a `streaming_config` message. - 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: - Iterable[google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse]: - StreamingRecognizeResponse is the only message returned to the client by - StreamingRecognize. A series of zero or more - StreamingRecognizeResponse messages are streamed back - to the client. If there is no recognizable audio, and - single_utterance is set to false, then no messages - are streamed back to the client. - - Here's an example of a series of - StreamingRecognizeResponses that might be returned - while processing audio: - - 1. results { alternatives { transcript: "tube" } - stability: 0.01 } - 2. results { alternatives { transcript: "to be a" } - stability: 0.01 } - 3. results { alternatives { transcript: "to be" } - stability: 0.9 } results { alternatives { - transcript: " or not to be" } stability: 0.01 } - 4. - - results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } - - alternatives { transcript: "to bee or not to bee" } - is_final: true } - - 5. results { alternatives { transcript: " that's" } - stability: 0.01 } - 6. results { alternatives { transcript: " that is" } - stability: 0.9 } results { alternatives { - transcript: " the question" } stability: 0.01 } - 7. - - results { alternatives { transcript: " that is the question" - confidence: 0.98 } - - alternatives { transcript: " that was the question" } - is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain - final results; they are indicated by - is_final: true. Concatenating these together - generates the full transcript: "to be or not to be - that is the question". - - The others contain interim results. #3 and #6 - contain two interim \`results`: the first portion - has a high stability and is less likely to change; - the second portion has a low stability and is very - likely to change. A UI designer might choose to - show only high stability results. - - The specific stability and confidence values shown - above are only for illustrative purposes. Actual - values may vary. - - - - In each response, only one of these fields will be set: - error, speech_event_type, or one or more - (repeated) results. - - """ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.streaming_recognize] - - # Send the request. - response = rpc( - requests, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-speech", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "SpeechClient", -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py deleted file mode 100644 index 9f7015bc..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/__init__.py +++ /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 -# -# 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 SpeechTransport -from .grpc import SpeechGrpcTransport -from .grpc_asyncio import SpeechGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[SpeechTransport]] -_transport_registry['grpc'] = SpeechGrpcTransport -_transport_registry['grpc_asyncio'] = SpeechGrpcAsyncIOTransport - -__all__ = ( - 'SpeechTransport', - 'SpeechGrpcTransport', - 'SpeechGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py deleted file mode 100644 index 8df6d724..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/base.py +++ /dev/null @@ -1,217 +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 -# -# 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 -import packaging.version -import pkg_resources - -import google.auth # type: ignore -import google.api_core # type: ignore -from google.api_core import exceptions as core_exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.speech_v1p1beta1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-speech', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -try: - # google.auth.__version__ was added in 1.26.0 - _GOOGLE_AUTH_VERSION = google.auth.__version__ -except AttributeError: - try: # try pkg_resources if it is available - _GOOGLE_AUTH_VERSION = pkg_resources.get_distribution("google-auth").version - except pkg_resources.DistributionNotFound: # pragma: NO COVER - _GOOGLE_AUTH_VERSION = None - - -class SpeechTransport(abc.ABC): - """Abstract transport class for Speech.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - ) - - DEFAULT_HOST: str = 'speech.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: 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, - **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. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = self._get_scopes_kwargs(self._host, scopes) - - # Save the scopes. - self._scopes = scopes or self.AUTH_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) - - # If the credentials is 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 - - # TODO(busunkim): This method is in the base transport - # to avoid duplicating code across the transport classes. These functions - # should be deleted once the minimum required versions of google-auth is increased. - - # TODO: Remove this function once google-auth >= 1.25.0 is required - @classmethod - def _get_scopes_kwargs(cls, host: str, scopes: Optional[Sequence[str]]) -> Dict[str, Optional[Sequence[str]]]: - """Returns scopes kwargs to pass to google-auth methods depending on the google-auth version""" - - scopes_kwargs = {} - - if _GOOGLE_AUTH_VERSION and ( - packaging.version.parse(_GOOGLE_AUTH_VERSION) - >= packaging.version.parse("1.25.0") - ): - scopes_kwargs = {"scopes": scopes, "default_scopes": cls.AUTH_SCOPES} - else: - scopes_kwargs = {"scopes": scopes or cls.AUTH_SCOPES} - - return scopes_kwargs - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.recognize: gapic_v1.method.wrap_method( - self.recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=client_info, - ), - self.long_running_recognize: gapic_v1.method.wrap_method( - self.long_running_recognize, - default_timeout=5000.0, - client_info=client_info, - ), - self.streaming_recognize: gapic_v1.method.wrap_method( - self.streaming_recognize, - 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=5000.0, - ), - default_timeout=5000.0, - client_info=client_info, - ), - } - - @property - def operations_client(self) -> operations_v1.OperationsClient: - """Return the client designed to process long-running operations.""" - raise NotImplementedError() - - @property - def recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - Union[ - cloud_speech.RecognizeResponse, - Awaitable[cloud_speech.RecognizeResponse] - ]]: - raise NotImplementedError() - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - Union[ - operations_pb2.Operation, - Awaitable[operations_pb2.Operation] - ]]: - raise NotImplementedError() - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - Union[ - cloud_speech.StreamingRecognizeResponse, - Awaitable[cloud_speech.StreamingRecognizeResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'SpeechTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py deleted file mode 100644 index ce51090b..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc.py +++ /dev/null @@ -1,328 +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 -# -# 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 # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.api_core import gapic_v1 # type: ignore -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.speech_v1p1beta1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore -from .base import SpeechTransport, DEFAULT_CLIENT_INFO - - -class SpeechGrpcTransport(SpeechTransport): - """gRPC backend transport for Speech. - - Service that implements Google Cloud Speech API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - 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 = 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: 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. - """ - # Sanity 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 recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - cloud_speech.RecognizeResponse]: - r"""Return a callable for the recognize method over gRPC. - - Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Returns: - Callable[[~.RecognizeRequest], - ~.RecognizeResponse]: - 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 'recognize' not in self._stubs: - self._stubs['recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Speech/Recognize', - request_serializer=cloud_speech.RecognizeRequest.serialize, - response_deserializer=cloud_speech.RecognizeResponse.deserialize, - ) - return self._stubs['recognize'] - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - operations_pb2.Operation]: - r"""Return a callable for the long running recognize method over gRPC. - - Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Returns: - Callable[[~.LongRunningRecognizeRequest], - ~.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 'long_running_recognize' not in self._stubs: - self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', - request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['long_running_recognize'] - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - cloud_speech.StreamingRecognizeResponse]: - r"""Return a callable for the streaming recognize method over gRPC. - - Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Returns: - Callable[[~.StreamingRecognizeRequest], - ~.StreamingRecognizeResponse]: - 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 'streaming_recognize' not in self._stubs: - self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( - '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', - request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, - response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, - ) - return self._stubs['streaming_recognize'] - - -__all__ = ( - 'SpeechGrpcTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py deleted file mode 100644 index f155c6cd..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/services/speech/transports/grpc_asyncio.py +++ /dev/null @@ -1,332 +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 -# -# 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 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google.api_core import operations_v1 # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -import packaging.version - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.speech_v1p1beta1.types import cloud_speech -from google.longrunning import operations_pb2 # type: ignore -from .base import SpeechTransport, DEFAULT_CLIENT_INFO -from .grpc import SpeechGrpcTransport - - -class SpeechGrpcAsyncIOTransport(SpeechTransport): - """gRPC AsyncIO backend transport for Speech. - - Service that implements Google Cloud Speech API. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'speech.googleapis.com', - credentials: 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 = 'speech.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> 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 applicatin 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 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 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. - - 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 = 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=True, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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. - """ - # Sanity 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 recognize(self) -> Callable[ - [cloud_speech.RecognizeRequest], - Awaitable[cloud_speech.RecognizeResponse]]: - r"""Return a callable for the recognize method over gRPC. - - Performs synchronous speech recognition: receive - results after all audio has been sent and processed. - - Returns: - Callable[[~.RecognizeRequest], - Awaitable[~.RecognizeResponse]]: - 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 'recognize' not in self._stubs: - self._stubs['recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Speech/Recognize', - request_serializer=cloud_speech.RecognizeRequest.serialize, - response_deserializer=cloud_speech.RecognizeResponse.deserialize, - ) - return self._stubs['recognize'] - - @property - def long_running_recognize(self) -> Callable[ - [cloud_speech.LongRunningRecognizeRequest], - Awaitable[operations_pb2.Operation]]: - r"""Return a callable for the long running recognize method over gRPC. - - Performs asynchronous speech recognition: receive results via - the google.longrunning.Operations interface. Returns either an - ``Operation.error`` or an ``Operation.response`` which contains - a ``LongRunningRecognizeResponse`` message. For more information - on asynchronous speech recognition, see the - `how-to `__. - - Returns: - Callable[[~.LongRunningRecognizeRequest], - 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 'long_running_recognize' not in self._stubs: - self._stubs['long_running_recognize'] = self.grpc_channel.unary_unary( - '/google.cloud.speech.v1p1beta1.Speech/LongRunningRecognize', - request_serializer=cloud_speech.LongRunningRecognizeRequest.serialize, - response_deserializer=operations_pb2.Operation.FromString, - ) - return self._stubs['long_running_recognize'] - - @property - def streaming_recognize(self) -> Callable[ - [cloud_speech.StreamingRecognizeRequest], - Awaitable[cloud_speech.StreamingRecognizeResponse]]: - r"""Return a callable for the streaming recognize method over gRPC. - - Performs bidirectional streaming speech recognition: - receive results while sending audio. This method is only - available via the gRPC API (not REST). - - Returns: - Callable[[~.StreamingRecognizeRequest], - Awaitable[~.StreamingRecognizeResponse]]: - 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 'streaming_recognize' not in self._stubs: - self._stubs['streaming_recognize'] = self.grpc_channel.stream_stream( - '/google.cloud.speech.v1p1beta1.Speech/StreamingRecognize', - request_serializer=cloud_speech.StreamingRecognizeRequest.serialize, - response_deserializer=cloud_speech.StreamingRecognizeResponse.deserialize, - ) - return self._stubs['streaming_recognize'] - - -__all__ = ( - 'SpeechGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py deleted file mode 100644 index 91fa91e0..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/__init__.py +++ /dev/null @@ -1,90 +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 -# -# 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 .cloud_speech import ( - LongRunningRecognizeMetadata, - LongRunningRecognizeRequest, - LongRunningRecognizeResponse, - RecognitionAudio, - RecognitionConfig, - RecognitionMetadata, - RecognizeRequest, - RecognizeResponse, - SpeakerDiarizationConfig, - SpeechContext, - SpeechRecognitionAlternative, - SpeechRecognitionResult, - StreamingRecognitionConfig, - StreamingRecognitionResult, - StreamingRecognizeRequest, - StreamingRecognizeResponse, - TranscriptOutputConfig, - WordInfo, -) -from .cloud_speech_adaptation import ( - CreateCustomClassRequest, - CreatePhraseSetRequest, - DeleteCustomClassRequest, - DeletePhraseSetRequest, - GetCustomClassRequest, - GetPhraseSetRequest, - ListCustomClassesRequest, - ListCustomClassesResponse, - ListPhraseSetRequest, - ListPhraseSetResponse, - UpdateCustomClassRequest, - UpdatePhraseSetRequest, -) -from .resource import ( - CustomClass, - PhraseSet, - SpeechAdaptation, -) - -__all__ = ( - 'LongRunningRecognizeMetadata', - 'LongRunningRecognizeRequest', - 'LongRunningRecognizeResponse', - 'RecognitionAudio', - 'RecognitionConfig', - 'RecognitionMetadata', - 'RecognizeRequest', - 'RecognizeResponse', - 'SpeakerDiarizationConfig', - 'SpeechContext', - 'SpeechRecognitionAlternative', - 'SpeechRecognitionResult', - 'StreamingRecognitionConfig', - 'StreamingRecognitionResult', - 'StreamingRecognizeRequest', - 'StreamingRecognizeResponse', - 'TranscriptOutputConfig', - 'WordInfo', - 'CreateCustomClassRequest', - 'CreatePhraseSetRequest', - 'DeleteCustomClassRequest', - 'DeletePhraseSetRequest', - 'GetCustomClassRequest', - 'GetPhraseSetRequest', - 'ListCustomClassesRequest', - 'ListCustomClassesResponse', - 'ListPhraseSetRequest', - 'ListPhraseSetResponse', - 'UpdateCustomClassRequest', - 'UpdatePhraseSetRequest', - 'CustomClass', - 'PhraseSet', - 'SpeechAdaptation', -) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py deleted file mode 100644 index 15fdb9cb..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech.py +++ /dev/null @@ -1,1190 +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 -# -# 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 proto # type: ignore - -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import duration_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.protobuf import wrappers_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.speech.v1p1beta1', - manifest={ - 'RecognizeRequest', - 'LongRunningRecognizeRequest', - 'TranscriptOutputConfig', - 'StreamingRecognizeRequest', - 'StreamingRecognitionConfig', - 'RecognitionConfig', - 'SpeakerDiarizationConfig', - 'RecognitionMetadata', - 'SpeechContext', - 'RecognitionAudio', - 'RecognizeResponse', - 'LongRunningRecognizeResponse', - 'LongRunningRecognizeMetadata', - 'StreamingRecognizeResponse', - 'StreamingRecognitionResult', - 'SpeechRecognitionResult', - 'SpeechRecognitionAlternative', - 'WordInfo', - }, -) - - -class RecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the ``Recognize`` - method. - - Attributes: - config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): - Required. The audio data to be recognized. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - audio = proto.Field( - proto.MESSAGE, - number=2, - message='RecognitionAudio', - ) - - -class LongRunningRecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the - ``LongRunningRecognize`` method. - - Attributes: - config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - audio (google.cloud.speech_v1p1beta1.types.RecognitionAudio): - Required. The audio data to be recognized. - output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): - Optional. Specifies an optional destination - for the recognition results. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - audio = proto.Field( - proto.MESSAGE, - number=2, - message='RecognitionAudio', - ) - output_config = proto.Field( - proto.MESSAGE, - number=4, - message='TranscriptOutputConfig', - ) - - -class TranscriptOutputConfig(proto.Message): - r"""Specifies an optional destination for the recognition - results. - - Attributes: - gcs_uri (str): - Specifies a Cloud Storage URI for the recognition results. - Must be specified in the format: - ``gs://bucket_name/object_name``, and the bucket must - already exist. - """ - - gcs_uri = proto.Field( - proto.STRING, - number=1, - oneof='output_type', - ) - - -class StreamingRecognizeRequest(proto.Message): - r"""The top-level message sent by the client for the - ``StreamingRecognize`` method. Multiple - ``StreamingRecognizeRequest`` messages are sent. The first message - must contain a ``streaming_config`` message and must not contain - ``audio_content``. All subsequent messages must contain - ``audio_content`` and must not contain a ``streaming_config`` - message. - - Attributes: - streaming_config (google.cloud.speech_v1p1beta1.types.StreamingRecognitionConfig): - Provides information to the recognizer that specifies how to - process the request. The first ``StreamingRecognizeRequest`` - message must contain a ``streaming_config`` message. - audio_content (bytes): - The audio data to be recognized. Sequential chunks of audio - data are sent in sequential ``StreamingRecognizeRequest`` - messages. The first ``StreamingRecognizeRequest`` message - must not contain ``audio_content`` data and all subsequent - ``StreamingRecognizeRequest`` messages must contain - ``audio_content`` data. The audio bytes must be encoded as - specified in ``RecognitionConfig``. Note: as with all bytes - fields, proto buffers use a pure binary representation (not - base64). See `content - limits `__. - """ - - streaming_config = proto.Field( - proto.MESSAGE, - number=1, - oneof='streaming_request', - message='StreamingRecognitionConfig', - ) - audio_content = proto.Field( - proto.BYTES, - number=2, - oneof='streaming_request', - ) - - -class StreamingRecognitionConfig(proto.Message): - r"""Provides information to the recognizer that specifies how to - process the request. - - Attributes: - config (google.cloud.speech_v1p1beta1.types.RecognitionConfig): - Required. Provides information to the - recognizer that specifies how to process the - request. - single_utterance (bool): - If ``false`` or omitted, the recognizer will perform - continuous recognition (continuing to wait for and process - audio even if the user pauses speaking) until the client - closes the input stream (gRPC API) or until the maximum time - limit has been reached. May return multiple - ``StreamingRecognitionResult``\ s with the ``is_final`` flag - set to ``true``. - - If ``true``, the recognizer will detect a single spoken - utterance. When it detects that the user has paused or - stopped speaking, it will return an - ``END_OF_SINGLE_UTTERANCE`` event and cease recognition. It - will return no more than one ``StreamingRecognitionResult`` - with the ``is_final`` flag set to ``true``. - - The ``single_utterance`` field can only be used with - specified models, otherwise an error is thrown. The - ``model`` field in [``RecognitionConfig``][] must be set to: - - - ``command_and_search`` - - ``phone_call`` AND additional field - ``useEnhanced``\ =\ ``true`` - - The ``model`` field is left undefined. In this case the - API auto-selects a model based on any other parameters - that you set in ``RecognitionConfig``. - interim_results (bool): - If ``true``, interim results (tentative hypotheses) may be - returned as they become available (these interim results are - indicated with the ``is_final=false`` flag). If ``false`` or - omitted, only ``is_final=true`` result(s) are returned. - """ - - config = proto.Field( - proto.MESSAGE, - number=1, - message='RecognitionConfig', - ) - single_utterance = proto.Field( - proto.BOOL, - number=2, - ) - interim_results = proto.Field( - proto.BOOL, - number=3, - ) - - -class RecognitionConfig(proto.Message): - r"""Provides information to the recognizer that specifies how to - process the request. - - Attributes: - encoding (google.cloud.speech_v1p1beta1.types.RecognitionConfig.AudioEncoding): - Encoding of audio data sent in all ``RecognitionAudio`` - messages. This field is optional for ``FLAC`` and ``WAV`` - audio files and required for all other audio formats. For - details, see - [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. - sample_rate_hertz (int): - Sample rate in Hertz of the audio data sent in all - ``RecognitionAudio`` messages. Valid values are: 8000-48000. - 16000 is optimal. For best results, set the sampling rate of - the audio source to 16000 Hz. If that's not possible, use - the native sample rate of the audio source (instead of - re-sampling). This field is optional for FLAC and WAV audio - files, but is required for all other audio formats. For - details, see - [AudioEncoding][google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding]. - audio_channel_count (int): - The number of channels in the input audio data. ONLY set - this for MULTI-CHANNEL recognition. Valid values for - LINEAR16 and FLAC are ``1``-``8``. Valid values for OGG_OPUS - are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and - SPEEX_WITH_HEADER_BYTE is only ``1``. If ``0`` or omitted, - defaults to one channel (mono). Note: We only recognize the - first channel by default. To perform independent recognition - on each channel set - ``enable_separate_recognition_per_channel`` to 'true'. - enable_separate_recognition_per_channel (bool): - This needs to be set to ``true`` explicitly and - ``audio_channel_count`` > 1 to get each channel recognized - separately. The recognition result will contain a - ``channel_tag`` field to state which channel that result - belongs to. If this is not true, we will only recognize the - first channel. The request is billed cumulatively for all - channels recognized: ``audio_channel_count`` multiplied by - the length of the audio. - language_code (str): - Required. The language of the supplied audio as a - `BCP-47 `__ - language tag. Example: "en-US". See `Language - Support `__ - for a list of the currently supported language codes. - alternative_language_codes (Sequence[str]): - A list of up to 3 additional - `BCP-47 `__ - language tags, listing possible alternative languages of the - supplied audio. See `Language - Support `__ - for a list of the currently supported language codes. If - alternative languages are listed, recognition result will - contain recognition in the most likely language detected - including the main language_code. The recognition result - will include the language tag of the language detected in - the audio. Note: This feature is only supported for Voice - Command and Voice Search use cases and performance may vary - for other use cases (e.g., phone call transcription). - max_alternatives (int): - Maximum number of recognition hypotheses to be returned. - Specifically, the maximum number of - ``SpeechRecognitionAlternative`` messages within each - ``SpeechRecognitionResult``. The server may return fewer - than ``max_alternatives``. Valid values are ``0``-``30``. A - value of ``0`` or ``1`` will return a maximum of one. If - omitted, will return a maximum of one. - profanity_filter (bool): - If set to ``true``, the server will attempt to filter out - profanities, replacing all but the initial character in each - filtered word with asterisks, e.g. "f***". If set to - ``false`` or omitted, profanities won't be filtered out. - adaptation (google.cloud.speech_v1p1beta1.types.SpeechAdaptation): - Speech adaptation configuration improves the accuracy of - speech recognition. When speech adaptation is set it - supersedes the ``speech_contexts`` field. For more - information, see the `speech - adaptation `__ - documentation. - speech_contexts (Sequence[google.cloud.speech_v1p1beta1.types.SpeechContext]): - Array of - [SpeechContext][google.cloud.speech.v1p1beta1.SpeechContext]. - A means to provide context to assist the speech recognition. - For more information, see `speech - adaptation `__. - enable_word_time_offsets (bool): - If ``true``, the top result includes a list of words and the - start and end time offsets (timestamps) for those words. If - ``false``, no word-level time offset information is - returned. The default is ``false``. - enable_word_confidence (bool): - If ``true``, the top result includes a list of words and the - confidence for those words. If ``false``, no word-level - confidence information is returned. The default is - ``false``. - enable_automatic_punctuation (bool): - If 'true', adds punctuation to recognition - result hypotheses. This feature is only - available in select languages. Setting this for - requests in other languages has no effect at - all. The default 'false' value does not add - punctuation to result hypotheses. - enable_spoken_punctuation (google.protobuf.wrappers_pb2.BoolValue): - The spoken punctuation behavior for the call If not set, - uses default behavior based on model of choice e.g. - command_and_search will enable spoken punctuation by default - If 'true', replaces spoken punctuation with the - corresponding symbols in the request. For example, "how are - you question mark" becomes "how are you?". See - https://cloud.google.com/speech-to-text/docs/spoken-punctuation - for support. If 'false', spoken punctuation is not replaced. - enable_spoken_emojis (google.protobuf.wrappers_pb2.BoolValue): - The spoken emoji behavior for the call - If not set, uses default behavior based on model - of choice If 'true', adds spoken emoji - formatting for the request. This will replace - spoken emojis with the corresponding Unicode - symbols in the final transcript. If 'false', - spoken emojis are not replaced. - enable_speaker_diarization (bool): - If 'true', enables speaker detection for each recognized - word in the top alternative of the recognition result using - a speaker_tag provided in the WordInfo. Note: Use - diarization_config instead. - diarization_speaker_count (int): - If set, specifies the estimated number of speakers in the - conversation. Defaults to '2'. Ignored unless - enable_speaker_diarization is set to true. Note: Use - diarization_config instead. - diarization_config (google.cloud.speech_v1p1beta1.types.SpeakerDiarizationConfig): - Config to enable speaker diarization and set - additional parameters to make diarization better - suited for your application. Note: When this is - enabled, we send all the words from the - beginning of the audio for the top alternative - in every consecutive STREAMING responses. This - is done in order to improve our speaker tags as - our models learn to identify the speakers in the - conversation over time. For non-streaming - requests, the diarization results will be - provided only in the top alternative of the - FINAL SpeechRecognitionResult. - metadata (google.cloud.speech_v1p1beta1.types.RecognitionMetadata): - Metadata regarding this request. - model (str): - Which model to select for the given request. Select the - model best suited to your domain to get best results. If a - model is not explicitly specified, then we auto-select a - model based on the parameters in the RecognitionConfig. - - .. raw:: html - - - - - - - - - - - - - - - - - - - - - - -
ModelDescription
command_and_searchBest for short queries such as voice commands or voice search.
phone_callBest for audio that originated from a phone call (typically - recorded at an 8khz sampling rate).
videoBest for audio that originated from video or includes multiple - speakers. Ideally the audio is recorded at a 16khz or greater - sampling rate. This is a premium model that costs more than the - standard rate.
defaultBest for audio that is not one of the specific audio models. - For example, long-form audio. Ideally the audio is high-fidelity, - recorded at a 16khz or greater sampling rate.
- use_enhanced (bool): - Set to true to use an enhanced model for speech recognition. - If ``use_enhanced`` is set to true and the ``model`` field - is not set, then an appropriate enhanced model is chosen if - an enhanced model exists for the audio. - - If ``use_enhanced`` is true and an enhanced version of the - specified model does not exist, then the speech is - recognized using the standard version of the specified - model. - """ - class AudioEncoding(proto.Enum): - r"""The encoding of the audio data sent in the request. - - All encodings support only 1 channel (mono) audio, unless the - ``audio_channel_count`` and - ``enable_separate_recognition_per_channel`` fields are set. - - For best results, the audio source should be captured and - transmitted using a lossless encoding (``FLAC`` or ``LINEAR16``). - The accuracy of the speech recognition can be reduced if lossy - codecs are used to capture or transmit audio, particularly if - background noise is present. Lossy codecs include ``MULAW``, - ``AMR``, ``AMR_WB``, ``OGG_OPUS``, ``SPEEX_WITH_HEADER_BYTE``, - ``MP3``. - - The ``FLAC`` and ``WAV`` audio file formats include a header that - describes the included audio content. You can request recognition - for ``WAV`` files that contain either ``LINEAR16`` or ``MULAW`` - encoded audio. If you send ``FLAC`` or ``WAV`` audio file format in - your request, you do not need to specify an ``AudioEncoding``; the - audio encoding format is determined from the file header. If you - specify an ``AudioEncoding`` when you send send ``FLAC`` or ``WAV`` - audio, the encoding configuration must match the encoding described - in the audio header; otherwise the request returns an - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] - error code. - """ - ENCODING_UNSPECIFIED = 0 - LINEAR16 = 1 - FLAC = 2 - MULAW = 3 - AMR = 4 - AMR_WB = 5 - OGG_OPUS = 6 - SPEEX_WITH_HEADER_BYTE = 7 - MP3 = 8 - WEBM_OPUS = 9 - - encoding = proto.Field( - proto.ENUM, - number=1, - enum=AudioEncoding, - ) - sample_rate_hertz = proto.Field( - proto.INT32, - number=2, - ) - audio_channel_count = proto.Field( - proto.INT32, - number=7, - ) - enable_separate_recognition_per_channel = proto.Field( - proto.BOOL, - number=12, - ) - language_code = proto.Field( - proto.STRING, - number=3, - ) - alternative_language_codes = proto.RepeatedField( - proto.STRING, - number=18, - ) - max_alternatives = proto.Field( - proto.INT32, - number=4, - ) - profanity_filter = proto.Field( - proto.BOOL, - number=5, - ) - adaptation = proto.Field( - proto.MESSAGE, - number=20, - message=resource.SpeechAdaptation, - ) - speech_contexts = proto.RepeatedField( - proto.MESSAGE, - number=6, - message='SpeechContext', - ) - enable_word_time_offsets = proto.Field( - proto.BOOL, - number=8, - ) - enable_word_confidence = proto.Field( - proto.BOOL, - number=15, - ) - enable_automatic_punctuation = proto.Field( - proto.BOOL, - number=11, - ) - enable_spoken_punctuation = proto.Field( - proto.MESSAGE, - number=22, - message=wrappers_pb2.BoolValue, - ) - enable_spoken_emojis = proto.Field( - proto.MESSAGE, - number=23, - message=wrappers_pb2.BoolValue, - ) - enable_speaker_diarization = proto.Field( - proto.BOOL, - number=16, - ) - diarization_speaker_count = proto.Field( - proto.INT32, - number=17, - ) - diarization_config = proto.Field( - proto.MESSAGE, - number=19, - message='SpeakerDiarizationConfig', - ) - metadata = proto.Field( - proto.MESSAGE, - number=9, - message='RecognitionMetadata', - ) - model = proto.Field( - proto.STRING, - number=13, - ) - use_enhanced = proto.Field( - proto.BOOL, - number=14, - ) - - -class SpeakerDiarizationConfig(proto.Message): - r"""Config to enable speaker diarization. - Attributes: - enable_speaker_diarization (bool): - If 'true', enables speaker detection for each recognized - word in the top alternative of the recognition result using - a speaker_tag provided in the WordInfo. - min_speaker_count (int): - Minimum number of speakers in the - conversation. This range gives you more - flexibility by allowing the system to - automatically determine the correct number of - speakers. If not set, the default value is 2. - max_speaker_count (int): - Maximum number of speakers in the - conversation. This range gives you more - flexibility by allowing the system to - automatically determine the correct number of - speakers. If not set, the default value is 6. - speaker_tag (int): - Output only. Unused. - """ - - enable_speaker_diarization = proto.Field( - proto.BOOL, - number=1, - ) - min_speaker_count = proto.Field( - proto.INT32, - number=2, - ) - max_speaker_count = proto.Field( - proto.INT32, - number=3, - ) - speaker_tag = proto.Field( - proto.INT32, - number=5, - ) - - -class RecognitionMetadata(proto.Message): - r"""Description of audio data to be recognized. - Attributes: - interaction_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.InteractionType): - The use case most closely describing the - audio content to be recognized. - industry_naics_code_of_audio (int): - The industry vertical to which this speech - recognition request most closely applies. This - is most indicative of the topics contained in - the audio. Use the 6-digit NAICS code to - identify the industry vertical - see - https://www.naics.com/search/. - microphone_distance (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.MicrophoneDistance): - The audio type that most closely describes - the audio being recognized. - original_media_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.OriginalMediaType): - The original media the speech was recorded - on. - recording_device_type (google.cloud.speech_v1p1beta1.types.RecognitionMetadata.RecordingDeviceType): - The type of device the speech was recorded - with. - recording_device_name (str): - The device used to make the recording. - Examples 'Nexus 5X' or 'Polycom SoundStation IP - 6000' or 'POTS' or 'VoIP' or 'Cardioid - Microphone'. - original_mime_type (str): - Mime type of the original audio file. For example - ``audio/m4a``, ``audio/x-alaw-basic``, ``audio/mp3``, - ``audio/3gpp``. A list of possible audio mime types is - maintained at - http://www.iana.org/assignments/media-types/media-types.xhtml#audio - obfuscated_id (int): - Obfuscated (privacy-protected) ID of the - user, to identify number of unique users using - the service. - audio_topic (str): - Description of the content. Eg. "Recordings - of federal supreme court hearings from 2012". - """ - class InteractionType(proto.Enum): - r"""Use case categories that the audio recognition request can be - described by. - """ - INTERACTION_TYPE_UNSPECIFIED = 0 - DISCUSSION = 1 - PRESENTATION = 2 - PHONE_CALL = 3 - VOICEMAIL = 4 - PROFESSIONALLY_PRODUCED = 5 - VOICE_SEARCH = 6 - VOICE_COMMAND = 7 - DICTATION = 8 - - class MicrophoneDistance(proto.Enum): - r"""Enumerates the types of capture settings describing an audio - file. - """ - MICROPHONE_DISTANCE_UNSPECIFIED = 0 - NEARFIELD = 1 - MIDFIELD = 2 - FARFIELD = 3 - - class OriginalMediaType(proto.Enum): - r"""The original media the speech was recorded on.""" - ORIGINAL_MEDIA_TYPE_UNSPECIFIED = 0 - AUDIO = 1 - VIDEO = 2 - - class RecordingDeviceType(proto.Enum): - r"""The type of device the speech was recorded with.""" - RECORDING_DEVICE_TYPE_UNSPECIFIED = 0 - SMARTPHONE = 1 - PC = 2 - PHONE_LINE = 3 - VEHICLE = 4 - OTHER_OUTDOOR_DEVICE = 5 - OTHER_INDOOR_DEVICE = 6 - - interaction_type = proto.Field( - proto.ENUM, - number=1, - enum=InteractionType, - ) - industry_naics_code_of_audio = proto.Field( - proto.UINT32, - number=3, - ) - microphone_distance = proto.Field( - proto.ENUM, - number=4, - enum=MicrophoneDistance, - ) - original_media_type = proto.Field( - proto.ENUM, - number=5, - enum=OriginalMediaType, - ) - recording_device_type = proto.Field( - proto.ENUM, - number=6, - enum=RecordingDeviceType, - ) - recording_device_name = proto.Field( - proto.STRING, - number=7, - ) - original_mime_type = proto.Field( - proto.STRING, - number=8, - ) - obfuscated_id = proto.Field( - proto.INT64, - number=9, - ) - audio_topic = proto.Field( - proto.STRING, - number=10, - ) - - -class SpeechContext(proto.Message): - r"""Provides "hints" to the speech recognizer to favor specific - words and phrases in the results. - - Attributes: - phrases (Sequence[str]): - A list of strings containing words and phrases "hints" so - that the speech recognition is more likely to recognize - them. This can be used to improve the accuracy for specific - words and phrases, for example, if specific commands are - typically spoken by the user. This can also be used to add - additional words to the vocabulary of the recognizer. See - `usage - limits `__. - - List items can also be set to classes for groups of words - that represent common concepts that occur in natural - language. For example, rather than providing phrase hints - for every month of the year, using the $MONTH class improves - the likelihood of correctly transcribing audio that includes - months. - boost (float): - Hint Boost. Positive value will increase the probability - that a specific phrase will be recognized over other similar - sounding phrases. The higher the boost, the higher the - chance of false positive recognition as well. Negative boost - values would correspond to anti-biasing. Anti-biasing is not - enabled, so negative boost will simply be ignored. Though - ``boost`` can accept a wide range of positive values, most - use cases are best served with values between 0 and 20. We - recommend using a binary search approach to finding the - optimal value for your use case. - """ - - phrases = proto.RepeatedField( - proto.STRING, - number=1, - ) - boost = proto.Field( - proto.FLOAT, - number=4, - ) - - -class RecognitionAudio(proto.Message): - r"""Contains audio data in the encoding specified in the - ``RecognitionConfig``. Either ``content`` or ``uri`` must be - supplied. Supplying both or neither returns - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. - See `content - limits `__. - - Attributes: - content (bytes): - The audio data bytes encoded as specified in - ``RecognitionConfig``. Note: as with all bytes fields, proto - buffers use a pure binary representation, whereas JSON - representations use base64. - uri (str): - URI that points to a file that contains audio data bytes as - specified in ``RecognitionConfig``. The file must not be - compressed (for example, gzip). Currently, only Google Cloud - Storage URIs are supported, which must be specified in the - following format: ``gs://bucket_name/object_name`` (other - URI formats return - [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). - For more information, see `Request - URIs `__. - """ - - content = proto.Field( - proto.BYTES, - number=1, - oneof='audio_source', - ) - uri = proto.Field( - proto.STRING, - number=2, - oneof='audio_source', - ) - - -class RecognizeResponse(proto.Message): - r"""The only message returned to the client by the ``Recognize`` method. - It contains the result as zero or more sequential - ``SpeechRecognitionResult`` messages. - - Attributes: - results (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): - Sequential list of transcription results - corresponding to sequential portions of audio. - """ - - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='SpeechRecognitionResult', - ) - - -class LongRunningRecognizeResponse(proto.Message): - r"""The only message returned to the client by the - ``LongRunningRecognize`` method. It contains the result as zero or - more sequential ``SpeechRecognitionResult`` messages. It is included - in the ``result.response`` field of the ``Operation`` returned by - the ``GetOperation`` call of the ``google::longrunning::Operations`` - service. - - Attributes: - results (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionResult]): - Sequential list of transcription results - corresponding to sequential portions of audio. - output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): - Original output config if present in the - request. - output_error (google.rpc.status_pb2.Status): - If the transcript output fails this field - contains the relevant error. - """ - - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='SpeechRecognitionResult', - ) - output_config = proto.Field( - proto.MESSAGE, - number=6, - message='TranscriptOutputConfig', - ) - output_error = proto.Field( - proto.MESSAGE, - number=7, - message=status_pb2.Status, - ) - - -class LongRunningRecognizeMetadata(proto.Message): - r"""Describes the progress of a long-running ``LongRunningRecognize`` - call. It is included in the ``metadata`` field of the ``Operation`` - returned by the ``GetOperation`` call of the - ``google::longrunning::Operations`` service. - - Attributes: - progress_percent (int): - Approximate percentage of audio processed - thus far. Guaranteed to be 100 when the audio is - fully processed and the results are available. - start_time (google.protobuf.timestamp_pb2.Timestamp): - Time when the request was received. - last_update_time (google.protobuf.timestamp_pb2.Timestamp): - Time of the most recent processing update. - uri (str): - Output only. The URI of the audio file being - transcribed. Empty if the audio was sent as byte - content. - output_config (google.cloud.speech_v1p1beta1.types.TranscriptOutputConfig): - Output only. A copy of the - TranscriptOutputConfig if it was set in the - request. - """ - - progress_percent = proto.Field( - proto.INT32, - number=1, - ) - start_time = proto.Field( - proto.MESSAGE, - number=2, - message=timestamp_pb2.Timestamp, - ) - last_update_time = proto.Field( - proto.MESSAGE, - number=3, - message=timestamp_pb2.Timestamp, - ) - uri = proto.Field( - proto.STRING, - number=4, - ) - output_config = proto.Field( - proto.MESSAGE, - number=5, - message='TranscriptOutputConfig', - ) - - -class StreamingRecognizeResponse(proto.Message): - r"""``StreamingRecognizeResponse`` is the only message returned to the - client by ``StreamingRecognize``. A series of zero or more - ``StreamingRecognizeResponse`` messages are streamed back to the - client. If there is no recognizable audio, and ``single_utterance`` - is set to false, then no messages are streamed back to the client. - - Here's an example of a series of ``StreamingRecognizeResponse``\ s - that might be returned while processing audio: - - 1. results { alternatives { transcript: "tube" } stability: 0.01 } - - 2. results { alternatives { transcript: "to be a" } stability: 0.01 - } - - 3. results { alternatives { transcript: "to be" } stability: 0.9 } - results { alternatives { transcript: " or not to be" } stability: - 0.01 } - - 4. results { alternatives { transcript: "to be or not to be" - confidence: 0.92 } alternatives { transcript: "to bee or not to - bee" } is_final: true } - - 5. results { alternatives { transcript: " that's" } stability: 0.01 - } - - 6. results { alternatives { transcript: " that is" } stability: 0.9 - } results { alternatives { transcript: " the question" } - stability: 0.01 } - - 7. results { alternatives { transcript: " that is the question" - confidence: 0.98 } alternatives { transcript: " that was the - question" } is_final: true } - - Notes: - - - Only two of the above responses #4 and #7 contain final results; - they are indicated by ``is_final: true``. Concatenating these - together generates the full transcript: "to be or not to be that - is the question". - - - The others contain interim ``results``. #3 and #6 contain two - interim ``results``: the first portion has a high stability and - is less likely to change; the second portion has a low stability - and is very likely to change. A UI designer might choose to show - only high stability ``results``. - - - The specific ``stability`` and ``confidence`` values shown above - are only for illustrative purposes. Actual values may vary. - - - In each response, only one of these fields will be set: - ``error``, ``speech_event_type``, or one or more (repeated) - ``results``. - - Attributes: - error (google.rpc.status_pb2.Status): - If set, returns a [google.rpc.Status][google.rpc.Status] - message that specifies the error for the operation. - results (Sequence[google.cloud.speech_v1p1beta1.types.StreamingRecognitionResult]): - This repeated list contains zero or more results that - correspond to consecutive portions of the audio currently - being processed. It contains zero or one ``is_final=true`` - result (the newly settled portion), followed by zero or more - ``is_final=false`` results (the interim results). - speech_event_type (google.cloud.speech_v1p1beta1.types.StreamingRecognizeResponse.SpeechEventType): - Indicates the type of speech event. - """ - class SpeechEventType(proto.Enum): - r"""Indicates the type of speech event.""" - SPEECH_EVENT_UNSPECIFIED = 0 - END_OF_SINGLE_UTTERANCE = 1 - - error = proto.Field( - proto.MESSAGE, - number=1, - message=status_pb2.Status, - ) - results = proto.RepeatedField( - proto.MESSAGE, - number=2, - message='StreamingRecognitionResult', - ) - speech_event_type = proto.Field( - proto.ENUM, - number=4, - enum=SpeechEventType, - ) - - -class StreamingRecognitionResult(proto.Message): - r"""A streaming speech recognition result corresponding to a - portion of the audio that is currently being processed. - - Attributes: - alternatives (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): - May contain one or more recognition hypotheses (up to the - maximum specified in ``max_alternatives``). These - alternatives are ordered in terms of accuracy, with the top - (first) alternative being the most probable, as ranked by - the recognizer. - is_final (bool): - If ``false``, this ``StreamingRecognitionResult`` represents - an interim result that may change. If ``true``, this is the - final time the speech service will return this particular - ``StreamingRecognitionResult``, the recognizer will not - return any further hypotheses for this portion of the - transcript and corresponding audio. - stability (float): - An estimate of the likelihood that the recognizer will not - change its guess about this interim result. Values range - from 0.0 (completely unstable) to 1.0 (completely stable). - This field is only provided for interim results - (``is_final=false``). The default of 0.0 is a sentinel value - indicating ``stability`` was not set. - result_end_time (google.protobuf.duration_pb2.Duration): - Time offset of the end of this result - relative to the beginning of the audio. - channel_tag (int): - For multi-channel audio, this is the channel number - corresponding to the recognized result for the audio from - that channel. For audio_channel_count = N, its output values - can range from '1' to 'N'. - language_code (str): - Output only. The - `BCP-47 `__ - language tag of the language in this result. This language - code was detected to have the most likelihood of being - spoken in the audio. - """ - - alternatives = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SpeechRecognitionAlternative', - ) - is_final = proto.Field( - proto.BOOL, - number=2, - ) - stability = proto.Field( - proto.FLOAT, - number=3, - ) - result_end_time = proto.Field( - proto.MESSAGE, - number=4, - message=duration_pb2.Duration, - ) - channel_tag = proto.Field( - proto.INT32, - number=5, - ) - language_code = proto.Field( - proto.STRING, - number=6, - ) - - -class SpeechRecognitionResult(proto.Message): - r"""A speech recognition result corresponding to a portion of the - audio. - - Attributes: - alternatives (Sequence[google.cloud.speech_v1p1beta1.types.SpeechRecognitionAlternative]): - May contain one or more recognition hypotheses (up to the - maximum specified in ``max_alternatives``). These - alternatives are ordered in terms of accuracy, with the top - (first) alternative being the most probable, as ranked by - the recognizer. - channel_tag (int): - For multi-channel audio, this is the channel number - corresponding to the recognized result for the audio from - that channel. For audio_channel_count = N, its output values - can range from '1' to 'N'. - language_code (str): - Output only. The - `BCP-47 `__ - language tag of the language in this result. This language - code was detected to have the most likelihood of being - spoken in the audio. - """ - - alternatives = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='SpeechRecognitionAlternative', - ) - channel_tag = proto.Field( - proto.INT32, - number=2, - ) - language_code = proto.Field( - proto.STRING, - number=5, - ) - - -class SpeechRecognitionAlternative(proto.Message): - r"""Alternative hypotheses (a.k.a. n-best list). - Attributes: - transcript (str): - Transcript text representing the words that - the user spoke. - confidence (float): - The confidence estimate between 0.0 and 1.0. A higher number - indicates an estimated greater likelihood that the - recognized words are correct. This field is set only for the - top alternative of a non-streaming result or, of a streaming - result where ``is_final=true``. This field is not guaranteed - to be accurate and users should not rely on it to be always - provided. The default of 0.0 is a sentinel value indicating - ``confidence`` was not set. - words (Sequence[google.cloud.speech_v1p1beta1.types.WordInfo]): - A list of word-specific information for each recognized - word. Note: When ``enable_speaker_diarization`` is true, you - will see all the words from the beginning of the audio. - """ - - transcript = proto.Field( - proto.STRING, - number=1, - ) - confidence = proto.Field( - proto.FLOAT, - number=2, - ) - words = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='WordInfo', - ) - - -class WordInfo(proto.Message): - r"""Word-specific information for recognized words. - Attributes: - start_time (google.protobuf.duration_pb2.Duration): - Time offset relative to the beginning of the audio, and - corresponding to the start of the spoken word. This field is - only set if ``enable_word_time_offsets=true`` and only in - the top hypothesis. This is an experimental feature and the - accuracy of the time offset can vary. - end_time (google.protobuf.duration_pb2.Duration): - Time offset relative to the beginning of the audio, and - corresponding to the end of the spoken word. This field is - only set if ``enable_word_time_offsets=true`` and only in - the top hypothesis. This is an experimental feature and the - accuracy of the time offset can vary. - word (str): - The word corresponding to this set of - information. - confidence (float): - The confidence estimate between 0.0 and 1.0. A higher number - indicates an estimated greater likelihood that the - recognized words are correct. This field is set only for the - top alternative of a non-streaming result or, of a streaming - result where ``is_final=true``. This field is not guaranteed - to be accurate and users should not rely on it to be always - provided. The default of 0.0 is a sentinel value indicating - ``confidence`` was not set. - speaker_tag (int): - Output only. A distinct integer value is assigned for every - speaker within the audio. This field specifies which one of - those speakers was detected to have spoken this word. Value - ranges from '1' to diarization_speaker_count. speaker_tag is - set if enable_speaker_diarization = 'true' and only in the - top alternative. - """ - - start_time = proto.Field( - proto.MESSAGE, - number=1, - message=duration_pb2.Duration, - ) - end_time = proto.Field( - proto.MESSAGE, - number=2, - message=duration_pb2.Duration, - ) - word = proto.Field( - proto.STRING, - number=3, - ) - confidence = proto.Field( - proto.FLOAT, - number=4, - ) - speaker_tag = proto.Field( - proto.INT32, - number=5, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py deleted file mode 100644 index 5c0345b6..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/cloud_speech_adaptation.py +++ /dev/null @@ -1,335 +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 -# -# 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 proto # type: ignore - -from google.cloud.speech_v1p1beta1.types import resource -from google.protobuf import field_mask_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.speech.v1p1beta1', - manifest={ - 'CreatePhraseSetRequest', - 'UpdatePhraseSetRequest', - 'GetPhraseSetRequest', - 'ListPhraseSetRequest', - 'ListPhraseSetResponse', - 'DeletePhraseSetRequest', - 'CreateCustomClassRequest', - 'UpdateCustomClassRequest', - 'GetCustomClassRequest', - 'ListCustomClassesRequest', - 'ListCustomClassesResponse', - 'DeleteCustomClassRequest', - }, -) - - -class CreatePhraseSetRequest(proto.Message): - r"""Message sent by the client for the ``CreatePhraseSet`` method. - Attributes: - parent (str): - Required. The parent resource where this phrase set will be - created. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets - phrase_set_id (str): - The ID to use for the phrase set, which will become the - final component of the phrase set's resource name. - - This value should be 4-63 characters, and valid characters - are /[a-z][0-9]-/. - phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): - Required. The phrase set to create. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - phrase_set_id = proto.Field( - proto.STRING, - number=2, - ) - phrase_set = proto.Field( - proto.MESSAGE, - number=3, - message=resource.PhraseSet, - ) - - -class UpdatePhraseSetRequest(proto.Message): - r"""Message sent by the client for the ``UpdatePhraseSet`` method. - Attributes: - phrase_set (google.cloud.speech_v1p1beta1.types.PhraseSet): - Required. The phrase set to update. - - The phrase set's ``name`` field is used to identify the set - to be updated. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be updated. - """ - - phrase_set = proto.Field( - proto.MESSAGE, - number=1, - message=resource.PhraseSet, - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class GetPhraseSetRequest(proto.Message): - r"""Message sent by the client for the ``GetPhraseSet`` method. - Attributes: - name (str): - Required. The name of the phrase set to retrieve. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class ListPhraseSetRequest(proto.Message): - r"""Message sent by the client for the ``ListPhraseSet`` method. - Attributes: - parent (str): - Required. The parent, which owns this - collection of phrase set. Format: - projects/{project}/locations/{location} - page_size (int): - The maximum number of phrase sets to return. - The service may return fewer than this value. If - unspecified, at most 50 phrase sets will be - returned. The maximum value is 1000; values - above 1000 will be coerced to 1000. - page_token (str): - A page token, received from a previous ``ListPhraseSet`` - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - ``ListPhraseSet`` must match the call that provided the page - token. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListPhraseSetResponse(proto.Message): - r"""Message returned to the client by the ``ListPhraseSet`` method. - Attributes: - phrase_sets (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): - The phrase set. - next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. - """ - - @property - def raw_page(self): - return self - - phrase_sets = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=resource.PhraseSet, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class DeletePhraseSetRequest(proto.Message): - r"""Message sent by the client for the ``DeletePhraseSet`` method. - Attributes: - name (str): - Required. The name of the phrase set to delete. Format: - {api_version}/projects/{project}/locations/{location}/phraseSets/{phrase_set} - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class CreateCustomClassRequest(proto.Message): - r"""Message sent by the client for the ``CreateCustomClass`` method. - Attributes: - parent (str): - Required. The parent resource where this custom class will - be created. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - custom_class_id (str): - The ID to use for the custom class, which will become the - final component of the custom class' resource name. - - This value should be 4-63 characters, and valid characters - are /[a-z][0-9]-/. - custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): - Required. The custom class to create. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - custom_class_id = proto.Field( - proto.STRING, - number=2, - ) - custom_class = proto.Field( - proto.MESSAGE, - number=3, - message=resource.CustomClass, - ) - - -class UpdateCustomClassRequest(proto.Message): - r"""Message sent by the client for the ``UpdateCustomClass`` method. - Attributes: - custom_class (google.cloud.speech_v1p1beta1.types.CustomClass): - Required. The custom class to update. - - The custom class's ``name`` field is used to identify the - custom class to be updated. Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - update_mask (google.protobuf.field_mask_pb2.FieldMask): - The list of fields to be updated. - """ - - custom_class = proto.Field( - proto.MESSAGE, - number=1, - message=resource.CustomClass, - ) - update_mask = proto.Field( - proto.MESSAGE, - number=2, - message=field_mask_pb2.FieldMask, - ) - - -class GetCustomClassRequest(proto.Message): - r"""Message sent by the client for the ``GetCustomClass`` method. - Attributes: - name (str): - Required. The name of the custom class to retrieve. Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -class ListCustomClassesRequest(proto.Message): - r"""Message sent by the client for the ``ListCustomClasses`` method. - Attributes: - parent (str): - Required. The parent, which owns this collection of custom - classes. Format: - {api_version}/projects/{project}/locations/{location}/customClasses - page_size (int): - The maximum number of custom classes to - return. The service may return fewer than this - value. If unspecified, at most 50 custom classes - will be returned. The maximum value is 1000; - values above 1000 will be coerced to 1000. - page_token (str): - A page token, received from a previous ``ListCustomClass`` - call. Provide this to retrieve the subsequent page. - - When paginating, all other parameters provided to - ``ListCustomClass`` must match the call that provided the - page token. - """ - - parent = proto.Field( - proto.STRING, - number=1, - ) - page_size = proto.Field( - proto.INT32, - number=2, - ) - page_token = proto.Field( - proto.STRING, - number=3, - ) - - -class ListCustomClassesResponse(proto.Message): - r"""Message returned to the client by the ``ListCustomClasses`` method. - Attributes: - custom_classes (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass]): - The custom classes. - next_page_token (str): - A token, which can be sent as ``page_token`` to retrieve the - next page. If this field is omitted, there are no subsequent - pages. - """ - - @property - def raw_page(self): - return self - - custom_classes = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=resource.CustomClass, - ) - next_page_token = proto.Field( - proto.STRING, - number=2, - ) - - -class DeleteCustomClassRequest(proto.Message): - r"""Message sent by the client for the ``DeleteCustomClass`` method. - Attributes: - name (str): - Required. The name of the custom class to delete. Format: - {api_version}/projects/{project}/locations/{location}/customClasses/{custom_class} - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py b/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py deleted file mode 100644 index 9dfd5b50..00000000 --- a/owl-bot-staging/v1p1beta1/google/cloud/speech_v1p1beta1/types/resource.py +++ /dev/null @@ -1,195 +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 -# -# 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 proto # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.speech.v1p1beta1', - manifest={ - 'CustomClass', - 'PhraseSet', - 'SpeechAdaptation', - }, -) - - -class CustomClass(proto.Message): - r"""A set of words or phrases that represents a common concept - likely to appear in your audio, for example a list of passenger - ship names. CustomClass items can be substituted into - placeholders that you set in PhraseSet phrases. - - Attributes: - name (str): - The resource name of the custom class. - custom_class_id (str): - If this custom class is a resource, the custom_class_id is - the resource id of the CustomClass. Case sensitive. - items (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass.ClassItem]): - A collection of class items. - """ - - class ClassItem(proto.Message): - r"""An item of the class. - Attributes: - value (str): - The class item's value. - """ - - value = proto.Field( - proto.STRING, - number=1, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - custom_class_id = proto.Field( - proto.STRING, - number=2, - ) - items = proto.RepeatedField( - proto.MESSAGE, - number=3, - message=ClassItem, - ) - - -class PhraseSet(proto.Message): - r"""Provides "hints" to the speech recognizer to favor specific - words and phrases in the results. - - Attributes: - name (str): - The resource name of the phrase set. - phrases (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet.Phrase]): - A list of word and phrases. - boost (float): - Hint Boost. Positive value will increase the probability - that a specific phrase will be recognized over other similar - sounding phrases. The higher the boost, the higher the - chance of false positive recognition as well. Negative boost - values would correspond to anti-biasing. Anti-biasing is not - enabled, so negative boost will simply be ignored. Though - ``boost`` can accept a wide range of positive values, most - use cases are best served with values between 0 (exclusive) - and 20. We recommend using a binary search approach to - finding the optimal value for your use case. Speech - recognition will skip PhraseSets with a boost value of 0. - """ - - class Phrase(proto.Message): - r"""A phrases containing words and phrase "hints" so that the speech - recognition is more likely to recognize them. This can be used to - improve the accuracy for specific words and phrases, for example, if - specific commands are typically spoken by the user. This can also be - used to add additional words to the vocabulary of the recognizer. - See `usage - limits `__. - - List items can also include pre-built or custom classes containing - groups of words that represent common concepts that occur in natural - language. For example, rather than providing a phrase hint for every - month of the year (e.g. "i was born in january", "i was born in - febuary", ...), use the pre-built ``$MONTH`` class improves the - likelihood of correctly transcribing audio that includes months - (e.g. "i was born in $month"). To refer to pre-built classes, use - the class' symbol prepended with ``$`` e.g. ``$MONTH``. To refer to - custom classes that were defined inline in the request, set the - class's ``custom_class_id`` to a string unique to all class - resources and inline classes. Then use the class' id wrapped in - $\ ``{...}`` e.g. "${my-months}". To refer to custom classes - resources, use the class' id wrapped in ``${}`` (e.g. - ``${my-months}``). - - Attributes: - value (str): - The phrase itself. - boost (float): - Hint Boost. Overrides the boost set at the phrase set level. - Positive value will increase the probability that a specific - phrase will be recognized over other similar sounding - phrases. The higher the boost, the higher the chance of - false positive recognition as well. Negative boost values - would correspond to anti-biasing. Anti-biasing is not - enabled, so negative boost will simply be ignored. Though - ``boost`` can accept a wide range of positive values, most - use cases are best served with values between 0 and 20. We - recommend using a binary search approach to finding the - optimal value for your use case. Speech recognition will - skip PhraseSets with a boost value of 0. - """ - - value = proto.Field( - proto.STRING, - number=1, - ) - boost = proto.Field( - proto.FLOAT, - number=2, - ) - - name = proto.Field( - proto.STRING, - number=1, - ) - phrases = proto.RepeatedField( - proto.MESSAGE, - number=2, - message=Phrase, - ) - boost = proto.Field( - proto.FLOAT, - number=4, - ) - - -class SpeechAdaptation(proto.Message): - r"""Speech adaptation configuration. - Attributes: - phrase_sets (Sequence[google.cloud.speech_v1p1beta1.types.PhraseSet]): - A collection of phrase sets. To specify the hints inline, - leave the phrase set's ``name`` blank and fill in the rest - of its fields. Any phrase set can use any custom class. - phrase_set_references (Sequence[str]): - A collection of phrase set resource names to - use. - custom_classes (Sequence[google.cloud.speech_v1p1beta1.types.CustomClass]): - A collection of custom classes. To specify the classes - inline, leave the class' ``name`` blank and fill in the rest - of its fields, giving it a unique ``custom_class_id``. Refer - to the inline defined class in phrase hints by its - ``custom_class_id``. - """ - - phrase_sets = proto.RepeatedField( - proto.MESSAGE, - number=1, - message='PhraseSet', - ) - phrase_set_references = proto.RepeatedField( - proto.STRING, - number=2, - ) - custom_classes = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='CustomClass', - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1p1beta1/mypy.ini b/owl-bot-staging/v1p1beta1/mypy.ini deleted file mode 100644 index 4505b485..00000000 --- a/owl-bot-staging/v1p1beta1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1p1beta1/noxfile.py b/owl-bot-staging/v1p1beta1/noxfile.py deleted file mode 100644 index babeb777..00000000 --- a/owl-bot-staging/v1p1beta1/noxfile.py +++ /dev/null @@ -1,132 +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 -# -# 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 - -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") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/speech_v1p1beta1/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.7') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - 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='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py b/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py deleted file mode 100644 index 4701246e..00000000 --- a/owl-bot-staging/v1p1beta1/scripts/fixup_speech_v1p1beta1_keywords.py +++ /dev/null @@ -1,188 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -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 speechCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_custom_class': ('parent', 'custom_class', 'custom_class_id', ), - 'create_phrase_set': ('parent', 'phrase_set', 'phrase_set_id', ), - 'delete_custom_class': ('name', ), - 'delete_phrase_set': ('name', ), - 'get_custom_class': ('name', ), - 'get_phrase_set': ('name', ), - 'list_custom_classes': ('parent', 'page_size', 'page_token', ), - 'list_phrase_set': ('parent', 'page_size', 'page_token', ), - 'long_running_recognize': ('config', 'audio', 'output_config', ), - 'recognize': ('config', 'audio', ), - 'streaming_recognize': ('streaming_config', 'audio_content', ), - 'update_custom_class': ('custom_class', 'update_mask', ), - 'update_phrase_set': ('phrase_set', 'update_mask', ), - } - - 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: not a.keyword.value 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=speechCallTransformer(), -): - """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 speech 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/v1p1beta1/setup.py b/owl-bot-staging/v1p1beta1/setup.py deleted file mode 100644 index 1fe40131..00000000 --- a/owl-bot-staging/v1p1beta1/setup.py +++ /dev/null @@ -1,53 +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 -# -# 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 - -version = '0.1.0' - -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() - -setuptools.setup( - name='google-cloud-speech', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.27.0, < 2.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - 'packaging >= 14.3', ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1p1beta1/tests/__init__.py b/owl-bot-staging/v1p1beta1/tests/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1p1beta1/tests/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1p1beta1/tests/unit/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1p1beta1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1p1beta1/tests/unit/gapic/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1p1beta1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py deleted file mode 100644 index b54a5fcc..00000000 --- a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/__init__.py +++ /dev/null @@ -1,16 +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 -# -# 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/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py deleted file mode 100644 index 44014720..00000000 --- a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py +++ /dev/null @@ -1,3689 +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 -# -# 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 mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationAsyncClient -from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationClient -from google.cloud.speech_v1p1beta1.services.adaptation import pagers -from google.cloud.speech_v1p1beta1.services.adaptation import transports -from google.cloud.speech_v1p1beta1.services.adaptation.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.speech_v1p1beta1.types import cloud_speech_adaptation -from google.cloud.speech_v1p1beta1.types import resource -from google.oauth2 import service_account -from google.protobuf import field_mask_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -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 AdaptationClient._get_default_mtls_endpoint(None) is None - assert AdaptationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert AdaptationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert AdaptationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert AdaptationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert AdaptationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - AdaptationClient, - AdaptationAsyncClient, -]) -def test_adaptation_client_from_service_account_info(client_class): - 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) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - AdaptationClient, - AdaptationAsyncClient, -]) -def test_adaptation_client_service_account_always_use_jwt(client_class): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_called_with(True) - - -@pytest.mark.parametrize("client_class", [ - AdaptationClient, - AdaptationAsyncClient, -]) -def test_adaptation_client_from_service_account_file(client_class): - 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") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_adaptation_client_get_transport_class(): - transport = AdaptationClient.get_transport_class() - available_transports = [ - transports.AdaptationGrpcTransport, - ] - assert transport in available_transports - - transport = AdaptationClient.get_transport_class("grpc") - assert transport == transports.AdaptationGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), - (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) -@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) -def test_adaptation_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(AdaptationClient, '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(AdaptationClient, '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(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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - # 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() - - # 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() - - # 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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "true"), - (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (AdaptationClient, transports.AdaptationGrpcTransport, "grpc", "false"), - (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(AdaptationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationClient)) -@mock.patch.object(AdaptationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AdaptationAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_adaptation_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) - - 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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), - (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_adaptation_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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AdaptationClient, transports.AdaptationGrpcTransport, "grpc"), - (AdaptationAsyncClient, transports.AdaptationGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_adaptation_client_client_options_credentials_file(client_class, transport_class, transport_name): - # 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) - 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, - ) - - -def test_adaptation_client_client_options_from_dict(): - with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = AdaptationClient( - 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, - ) - - -def test_create_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): - client = AdaptationClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet( - name='name_value', - boost=0.551, - ) - response = client.create_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -def test_create_phrase_set_from_dict(): - test_create_phrase_set(request_type=dict) - - -def test_create_phrase_set_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 = AdaptationClient( - 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_phrase_set), - '__call__') as call: - client.create_phrase_set() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() - - -@pytest.mark.asyncio -async def test_create_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreatePhraseSetRequest): - client = AdaptationAsyncClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( - name='name_value', - boost=0.551, - )) - response = await client.create_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreatePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -@pytest.mark.asyncio -async def test_create_phrase_set_async_from_dict(): - await test_create_phrase_set_async(request_type=dict) - - -def test_create_phrase_set_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.CreatePhraseSetRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_phrase_set), - '__call__') as call: - call.return_value = resource.PhraseSet() - client.create_phrase_set(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_phrase_set_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.CreatePhraseSetRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_phrase_set), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - await client.create_phrase_set(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_phrase_set_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_phrase_set( - parent='parent_value', - phrase_set=resource.PhraseSet(name='name_value'), - phrase_set_id='phrase_set_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].phrase_set == resource.PhraseSet(name='name_value') - assert args[0].phrase_set_id == 'phrase_set_id_value' - - -def test_create_phrase_set_flattened_error(): - client = AdaptationClient( - 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_phrase_set( - cloud_speech_adaptation.CreatePhraseSetRequest(), - parent='parent_value', - phrase_set=resource.PhraseSet(name='name_value'), - phrase_set_id='phrase_set_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_phrase_set_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_phrase_set( - parent='parent_value', - phrase_set=resource.PhraseSet(name='name_value'), - phrase_set_id='phrase_set_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].phrase_set == resource.PhraseSet(name='name_value') - assert args[0].phrase_set_id == 'phrase_set_id_value' - - -@pytest.mark.asyncio -async def test_create_phrase_set_flattened_error_async(): - client = AdaptationAsyncClient( - 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_phrase_set( - cloud_speech_adaptation.CreatePhraseSetRequest(), - parent='parent_value', - phrase_set=resource.PhraseSet(name='name_value'), - phrase_set_id='phrase_set_id_value', - ) - - -def test_get_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.GetPhraseSetRequest): - client = AdaptationClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet( - name='name_value', - boost=0.551, - ) - response = client.get_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -def test_get_phrase_set_from_dict(): - test_get_phrase_set(request_type=dict) - - -def test_get_phrase_set_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 = AdaptationClient( - 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_phrase_set), - '__call__') as call: - client.get_phrase_set() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() - - -@pytest.mark.asyncio -async def test_get_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetPhraseSetRequest): - client = AdaptationAsyncClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( - name='name_value', - boost=0.551, - )) - response = await client.get_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetPhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -@pytest.mark.asyncio -async def test_get_phrase_set_async_from_dict(): - await test_get_phrase_set_async(request_type=dict) - - -def test_get_phrase_set_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.GetPhraseSetRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_phrase_set), - '__call__') as call: - call.return_value = resource.PhraseSet() - client.get_phrase_set(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_phrase_set_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.GetPhraseSetRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_phrase_set), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - await client.get_phrase_set(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_phrase_set_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_phrase_set( - 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] - assert args[0].name == 'name_value' - - -def test_get_phrase_set_flattened_error(): - client = AdaptationClient( - 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_phrase_set( - cloud_speech_adaptation.GetPhraseSetRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_phrase_set_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_phrase_set( - 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] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_phrase_set_flattened_error_async(): - client = AdaptationAsyncClient( - 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_phrase_set( - cloud_speech_adaptation.GetPhraseSetRequest(), - name='name_value', - ) - - -def test_list_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.ListPhraseSetRequest): - client = AdaptationClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListPhraseSetResponse( - next_page_token='next_page_token_value', - ) - response = client.list_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListPhraseSetPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_phrase_set_from_dict(): - test_list_phrase_set(request_type=dict) - - -def test_list_phrase_set_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 = AdaptationClient( - 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_phrase_set), - '__call__') as call: - client.list_phrase_set() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() - - -@pytest.mark.asyncio -async def test_list_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListPhraseSetRequest): - client = AdaptationAsyncClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListPhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListPhraseSetAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_phrase_set_async_from_dict(): - await test_list_phrase_set_async(request_type=dict) - - -def test_list_phrase_set_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.ListPhraseSetRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() - client.list_phrase_set(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_phrase_set_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.ListPhraseSetRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) - await client.list_phrase_set(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_phrase_set_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_phrase_set( - 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] - assert args[0].parent == 'parent_value' - - -def test_list_phrase_set_flattened_error(): - client = AdaptationClient( - 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_phrase_set( - cloud_speech_adaptation.ListPhraseSetRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_phrase_set_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListPhraseSetResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListPhraseSetResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_phrase_set( - 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] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_phrase_set_flattened_error_async(): - client = AdaptationAsyncClient( - 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_phrase_set( - cloud_speech_adaptation.ListPhraseSetRequest(), - parent='parent_value', - ) - - -def test_list_phrase_set_pager(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - resource.PhraseSet(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_phrase_set(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, resource.PhraseSet) - for i in results) - -def test_list_phrase_set_pages(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - resource.PhraseSet(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - ], - ), - RuntimeError, - ) - pages = list(client.list_phrase_set(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_phrase_set_async_pager(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - resource.PhraseSet(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_phrase_set(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, resource.PhraseSet) - for i in responses) - -@pytest.mark.asyncio -async def test_list_phrase_set_async_pages(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_phrase_set), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - resource.PhraseSet(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListPhraseSetResponse( - phrase_sets=[ - resource.PhraseSet(), - resource.PhraseSet(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_phrase_set(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_update_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): - client = AdaptationClient( - 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.update_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet( - name='name_value', - boost=0.551, - ) - response = client.update_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -def test_update_phrase_set_from_dict(): - test_update_phrase_set(request_type=dict) - - -def test_update_phrase_set_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 = AdaptationClient( - 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.update_phrase_set), - '__call__') as call: - client.update_phrase_set() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() - - -@pytest.mark.asyncio -async def test_update_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdatePhraseSetRequest): - client = AdaptationAsyncClient( - 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.update_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet( - name='name_value', - boost=0.551, - )) - response = await client.update_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdatePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.PhraseSet) - assert response.name == 'name_value' - assert math.isclose(response.boost, 0.551, rel_tol=1e-6) - - -@pytest.mark.asyncio -async def test_update_phrase_set_async_from_dict(): - await test_update_phrase_set_async(request_type=dict) - - -def test_update_phrase_set_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() - - request.phrase_set.name = 'phrase_set.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_phrase_set), - '__call__') as call: - call.return_value = resource.PhraseSet() - client.update_phrase_set(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', - 'phrase_set.name=phrase_set.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_phrase_set_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.UpdatePhraseSetRequest() - - request.phrase_set.name = 'phrase_set.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_phrase_set), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - await client.update_phrase_set(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', - 'phrase_set.name=phrase_set.name/value', - ) in kw['metadata'] - - -def test_update_phrase_set_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_phrase_set( - phrase_set=resource.PhraseSet(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_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] - assert args[0].phrase_set == resource.PhraseSet(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_phrase_set_flattened_error(): - client = AdaptationClient( - 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.update_phrase_set( - cloud_speech_adaptation.UpdatePhraseSetRequest(), - phrase_set=resource.PhraseSet(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_phrase_set_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.PhraseSet() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.PhraseSet()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_phrase_set( - phrase_set=resource.PhraseSet(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].phrase_set == resource.PhraseSet(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_phrase_set_flattened_error_async(): - client = AdaptationAsyncClient( - 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.update_phrase_set( - cloud_speech_adaptation.UpdatePhraseSetRequest(), - phrase_set=resource.PhraseSet(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_phrase_set(transport: str = 'grpc', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): - client = AdaptationClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_phrase_set_from_dict(): - test_delete_phrase_set(request_type=dict) - - -def test_delete_phrase_set_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 = AdaptationClient( - 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_phrase_set), - '__call__') as call: - client.delete_phrase_set() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() - - -@pytest.mark.asyncio -async def test_delete_phrase_set_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeletePhraseSetRequest): - client = AdaptationAsyncClient( - 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_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_phrase_set(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeletePhraseSetRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_phrase_set_async_from_dict(): - await test_delete_phrase_set_async(request_type=dict) - - -def test_delete_phrase_set_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.DeletePhraseSetRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_phrase_set), - '__call__') as call: - call.return_value = None - client.delete_phrase_set(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_phrase_set_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.DeletePhraseSetRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_phrase_set), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_phrase_set(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_phrase_set_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_phrase_set( - 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] - assert args[0].name == 'name_value' - - -def test_delete_phrase_set_flattened_error(): - client = AdaptationClient( - 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_phrase_set( - cloud_speech_adaptation.DeletePhraseSetRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_phrase_set_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_phrase_set), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_phrase_set( - 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] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_phrase_set_flattened_error_async(): - client = AdaptationAsyncClient( - 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_phrase_set( - cloud_speech_adaptation.DeletePhraseSetRequest(), - name='name_value', - ) - - -def test_create_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.CreateCustomClassRequest): - client = AdaptationClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - ) - response = client.create_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -def test_create_custom_class_from_dict(): - test_create_custom_class(request_type=dict) - - -def test_create_custom_class_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 = AdaptationClient( - 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_custom_class), - '__call__') as call: - client.create_custom_class() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() - - -@pytest.mark.asyncio -async def test_create_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.CreateCustomClassRequest): - client = AdaptationAsyncClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - )) - response = await client.create_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.CreateCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -@pytest.mark.asyncio -async def test_create_custom_class_async_from_dict(): - await test_create_custom_class_async(request_type=dict) - - -def test_create_custom_class_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.CreateCustomClassRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_custom_class), - '__call__') as call: - call.return_value = resource.CustomClass() - client.create_custom_class(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_custom_class_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.CreateCustomClassRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_custom_class), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - await client.create_custom_class(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_custom_class_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_custom_class( - parent='parent_value', - custom_class=resource.CustomClass(name='name_value'), - custom_class_id='custom_class_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].custom_class == resource.CustomClass(name='name_value') - assert args[0].custom_class_id == 'custom_class_id_value' - - -def test_create_custom_class_flattened_error(): - client = AdaptationClient( - 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_custom_class( - cloud_speech_adaptation.CreateCustomClassRequest(), - parent='parent_value', - custom_class=resource.CustomClass(name='name_value'), - custom_class_id='custom_class_id_value', - ) - - -@pytest.mark.asyncio -async def test_create_custom_class_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_custom_class( - parent='parent_value', - custom_class=resource.CustomClass(name='name_value'), - custom_class_id='custom_class_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].parent == 'parent_value' - assert args[0].custom_class == resource.CustomClass(name='name_value') - assert args[0].custom_class_id == 'custom_class_id_value' - - -@pytest.mark.asyncio -async def test_create_custom_class_flattened_error_async(): - client = AdaptationAsyncClient( - 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_custom_class( - cloud_speech_adaptation.CreateCustomClassRequest(), - parent='parent_value', - custom_class=resource.CustomClass(name='name_value'), - custom_class_id='custom_class_id_value', - ) - - -def test_get_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.GetCustomClassRequest): - client = AdaptationClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - ) - response = client.get_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -def test_get_custom_class_from_dict(): - test_get_custom_class(request_type=dict) - - -def test_get_custom_class_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 = AdaptationClient( - 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_custom_class), - '__call__') as call: - client.get_custom_class() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() - - -@pytest.mark.asyncio -async def test_get_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.GetCustomClassRequest): - client = AdaptationAsyncClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - )) - response = await client.get_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.GetCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -@pytest.mark.asyncio -async def test_get_custom_class_async_from_dict(): - await test_get_custom_class_async(request_type=dict) - - -def test_get_custom_class_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.GetCustomClassRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_custom_class), - '__call__') as call: - call.return_value = resource.CustomClass() - client.get_custom_class(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_custom_class_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.GetCustomClassRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_custom_class), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - await client.get_custom_class(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_custom_class_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_custom_class( - 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] - assert args[0].name == 'name_value' - - -def test_get_custom_class_flattened_error(): - client = AdaptationClient( - 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_custom_class( - cloud_speech_adaptation.GetCustomClassRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_get_custom_class_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_custom_class( - 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] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_custom_class_flattened_error_async(): - client = AdaptationAsyncClient( - 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_custom_class( - cloud_speech_adaptation.GetCustomClassRequest(), - name='name_value', - ) - - -def test_list_custom_classes(transport: str = 'grpc', request_type=cloud_speech_adaptation.ListCustomClassesRequest): - client = AdaptationClient( - 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_custom_classes), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListCustomClassesResponse( - next_page_token='next_page_token_value', - ) - response = client.list_custom_classes(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCustomClassesPager) - assert response.next_page_token == 'next_page_token_value' - - -def test_list_custom_classes_from_dict(): - test_list_custom_classes(request_type=dict) - - -def test_list_custom_classes_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 = AdaptationClient( - 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_custom_classes), - '__call__') as call: - client.list_custom_classes() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() - - -@pytest.mark.asyncio -async def test_list_custom_classes_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.ListCustomClassesRequest): - client = AdaptationAsyncClient( - 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_custom_classes), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse( - next_page_token='next_page_token_value', - )) - response = await client.list_custom_classes(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.ListCustomClassesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, pagers.ListCustomClassesAsyncPager) - assert response.next_page_token == 'next_page_token_value' - - -@pytest.mark.asyncio -async def test_list_custom_classes_async_from_dict(): - await test_list_custom_classes_async(request_type=dict) - - -def test_list_custom_classes_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.ListCustomClassesRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() - client.list_custom_classes(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_custom_classes_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.ListCustomClassesRequest() - - request.parent = 'parent/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) - await client.list_custom_classes(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_custom_classes_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_custom_classes( - 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] - assert args[0].parent == 'parent_value' - - -def test_list_custom_classes_flattened_error(): - client = AdaptationClient( - 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_custom_classes( - cloud_speech_adaptation.ListCustomClassesRequest(), - parent='parent_value', - ) - - -@pytest.mark.asyncio -async def test_list_custom_classes_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech_adaptation.ListCustomClassesResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech_adaptation.ListCustomClassesResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_custom_classes( - 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] - assert args[0].parent == 'parent_value' - - -@pytest.mark.asyncio -async def test_list_custom_classes_flattened_error_async(): - client = AdaptationAsyncClient( - 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_custom_classes( - cloud_speech_adaptation.ListCustomClassesRequest(), - parent='parent_value', - ) - - -def test_list_custom_classes_pager(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - resource.CustomClass(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - ], - ), - RuntimeError, - ) - - metadata = () - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', ''), - )), - ) - pager = client.list_custom_classes(request={}) - - assert pager._metadata == metadata - - results = [i for i in pager] - assert len(results) == 6 - assert all(isinstance(i, resource.CustomClass) - for i in results) - -def test_list_custom_classes_pages(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__') as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - resource.CustomClass(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - ], - ), - RuntimeError, - ) - pages = list(client.list_custom_classes(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_custom_classes_async_pager(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - resource.CustomClass(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - ], - ), - RuntimeError, - ) - async_pager = await client.list_custom_classes(request={},) - assert async_pager.next_page_token == 'abc' - responses = [] - async for response in async_pager: - responses.append(response) - - assert len(responses) == 6 - assert all(isinstance(i, resource.CustomClass) - for i in responses) - -@pytest.mark.asyncio -async def test_list_custom_classes_async_pages(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials, - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_custom_classes), - '__call__', new_callable=mock.AsyncMock) as call: - # Set the response to a series of pages. - call.side_effect = ( - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - resource.CustomClass(), - ], - next_page_token='abc', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[], - next_page_token='def', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - ], - next_page_token='ghi', - ), - cloud_speech_adaptation.ListCustomClassesResponse( - custom_classes=[ - resource.CustomClass(), - resource.CustomClass(), - ], - ), - RuntimeError, - ) - pages = [] - async for page_ in (await client.list_custom_classes(request={})).pages: - pages.append(page_) - for page_, token in zip(pages, ['abc','def','ghi', '']): - assert page_.raw_page.next_page_token == token - -def test_update_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): - client = AdaptationClient( - 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.update_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - ) - response = client.update_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -def test_update_custom_class_from_dict(): - test_update_custom_class(request_type=dict) - - -def test_update_custom_class_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 = AdaptationClient( - 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.update_custom_class), - '__call__') as call: - client.update_custom_class() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() - - -@pytest.mark.asyncio -async def test_update_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.UpdateCustomClassRequest): - client = AdaptationAsyncClient( - 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.update_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass( - name='name_value', - custom_class_id='custom_class_id_value', - )) - response = await client.update_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.UpdateCustomClassRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, resource.CustomClass) - assert response.name == 'name_value' - assert response.custom_class_id == 'custom_class_id_value' - - -@pytest.mark.asyncio -async def test_update_custom_class_async_from_dict(): - await test_update_custom_class_async(request_type=dict) - - -def test_update_custom_class_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.UpdateCustomClassRequest() - - request.custom_class.name = 'custom_class.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_custom_class), - '__call__') as call: - call.return_value = resource.CustomClass() - client.update_custom_class(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', - 'custom_class.name=custom_class.name/value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_custom_class_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.UpdateCustomClassRequest() - - request.custom_class.name = 'custom_class.name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_custom_class), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - await client.update_custom_class(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', - 'custom_class.name=custom_class.name/value', - ) in kw['metadata'] - - -def test_update_custom_class_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_custom_class( - custom_class=resource.CustomClass(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_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] - assert args[0].custom_class == resource.CustomClass(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -def test_update_custom_class_flattened_error(): - client = AdaptationClient( - 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.update_custom_class( - cloud_speech_adaptation.UpdateCustomClassRequest(), - custom_class=resource.CustomClass(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_custom_class_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = resource.CustomClass() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(resource.CustomClass()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_custom_class( - custom_class=resource.CustomClass(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].custom_class == resource.CustomClass(name='name_value') - assert args[0].update_mask == field_mask_pb2.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_custom_class_flattened_error_async(): - client = AdaptationAsyncClient( - 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.update_custom_class( - cloud_speech_adaptation.UpdateCustomClassRequest(), - custom_class=resource.CustomClass(name='name_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_delete_custom_class(transport: str = 'grpc', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): - client = AdaptationClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_custom_class_from_dict(): - test_delete_custom_class(request_type=dict) - - -def test_delete_custom_class_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 = AdaptationClient( - 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_custom_class), - '__call__') as call: - client.delete_custom_class() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() - - -@pytest.mark.asyncio -async def test_delete_custom_class_async(transport: str = 'grpc_asyncio', request_type=cloud_speech_adaptation.DeleteCustomClassRequest): - client = AdaptationAsyncClient( - 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_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_custom_class(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech_adaptation.DeleteCustomClassRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_custom_class_async_from_dict(): - await test_delete_custom_class_async(request_type=dict) - - -def test_delete_custom_class_field_headers(): - client = AdaptationClient( - 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 = cloud_speech_adaptation.DeleteCustomClassRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_custom_class), - '__call__') as call: - call.return_value = None - client.delete_custom_class(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_custom_class_field_headers_async(): - client = AdaptationAsyncClient( - 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 = cloud_speech_adaptation.DeleteCustomClassRequest() - - request.name = 'name/value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_custom_class), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_custom_class(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_custom_class_flattened(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_custom_class( - 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] - assert args[0].name == 'name_value' - - -def test_delete_custom_class_flattened_error(): - client = AdaptationClient( - 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_custom_class( - cloud_speech_adaptation.DeleteCustomClassRequest(), - name='name_value', - ) - - -@pytest.mark.asyncio -async def test_delete_custom_class_flattened_async(): - client = AdaptationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_custom_class), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_custom_class( - 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] - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_custom_class_flattened_error_async(): - client = AdaptationAsyncClient( - 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_custom_class( - cloud_speech_adaptation.DeleteCustomClassRequest(), - name='name_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.AdaptationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.AdaptationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AdaptationClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.AdaptationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AdaptationClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.AdaptationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = AdaptationClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.AdaptationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.AdaptationGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.AdaptationGrpcTransport, - transports.AdaptationGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.AdaptationGrpcTransport, - ) - -def test_adaptation_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.AdaptationTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_adaptation_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.AdaptationTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_phrase_set', - 'get_phrase_set', - 'list_phrase_set', - 'update_phrase_set', - 'delete_phrase_set', - 'create_custom_class', - 'get_custom_class', - 'list_custom_classes', - 'update_custom_class', - 'delete_custom_class', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - -@requires_google_auth_gte_1_25_0 -def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AdaptationTransport( - 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', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_adaptation_base_transport_with_credentials_file_old_google_auth(): - # 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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AdaptationTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_adaptation_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.speech_v1p1beta1.services.adaptation.transports.AdaptationTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AdaptationTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_adaptation_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) - AdaptationClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_adaptation_auth_adc_old_google_auth(): - # 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) - AdaptationClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.AdaptationGrpcTransport, - transports.AdaptationGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_adaptation_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',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.AdaptationGrpcTransport, - transports.AdaptationGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_adaptation_transport_auth_adc_old_google_auth(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") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AdaptationGrpcTransport, grpc_helpers), - (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_adaptation_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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="speech.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) -def test_adaptation_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_adaptation_host_no_port(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), - ) - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_adaptation_host_with_port(): - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), - ) - assert client.transport._host == 'speech.googleapis.com:8000' - -def test_adaptation_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AdaptationGrpcTransport( - 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_adaptation_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AdaptationGrpcAsyncIOTransport( - 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) -def test_adaptation_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport]) -def test_adaptation_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_custom_class_path(): - project = "squid" - location = "clam" - custom_class = "whelk" - expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) - actual = AdaptationClient.custom_class_path(project, location, custom_class) - assert expected == actual - - -def test_parse_custom_class_path(): - expected = { - "project": "octopus", - "location": "oyster", - "custom_class": "nudibranch", - } - path = AdaptationClient.custom_class_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_custom_class_path(path) - assert expected == actual - -def test_phrase_set_path(): - project = "cuttlefish" - location = "mussel" - phrase_set = "winkle" - expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) - actual = AdaptationClient.phrase_set_path(project, location, phrase_set) - assert expected == actual - - -def test_parse_phrase_set_path(): - expected = { - "project": "nautilus", - "location": "scallop", - "phrase_set": "abalone", - } - path = AdaptationClient.phrase_set_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_phrase_set_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = AdaptationClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = AdaptationClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = AdaptationClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = AdaptationClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = AdaptationClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = AdaptationClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = AdaptationClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = AdaptationClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = AdaptationClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = AdaptationClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = AdaptationClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: - client = AdaptationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.AdaptationTransport, '_prep_wrapped_messages') as prep: - transport_class = AdaptationClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py b/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py deleted file mode 100644 index df95bc95..00000000 --- a/owl-bot-staging/v1p1beta1/tests/unit/gapic/speech_v1p1beta1/test_speech.py +++ /dev/null @@ -1,1406 +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 -# -# 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 mock -import packaging.version - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -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_async # type: ignore -from google.api_core import operations_v1 -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.speech_v1p1beta1.services.speech import SpeechAsyncClient -from google.cloud.speech_v1p1beta1.services.speech import SpeechClient -from google.cloud.speech_v1p1beta1.services.speech import transports -from google.cloud.speech_v1p1beta1.services.speech.transports.base import _GOOGLE_AUTH_VERSION -from google.cloud.speech_v1p1beta1.types import cloud_speech -from google.cloud.speech_v1p1beta1.types import resource -from google.longrunning import operations_pb2 -from google.oauth2 import service_account -from google.protobuf import wrappers_pb2 # type: ignore -from google.rpc import status_pb2 # type: ignore -import google.auth - - -# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively -# through google-api-core: -# - Delete the auth "less than" test cases -# - Delete these pytest markers (Make the "greater than or equal to" tests the default). -requires_google_auth_lt_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), - reason="This test requires google-auth < 1.25.0", -) -requires_google_auth_gte_1_25_0 = pytest.mark.skipif( - packaging.version.parse(_GOOGLE_AUTH_VERSION) < packaging.version.parse("1.25.0"), - reason="This test requires google-auth >= 1.25.0", -) - -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 SpeechClient._get_default_mtls_endpoint(None) is None - assert SpeechClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert SpeechClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_from_service_account_info(client_class): - 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) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_service_account_always_use_jwt(client_class): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - client = client_class(credentials=creds) - use_jwt.assert_called_with(True) - - -@pytest.mark.parametrize("client_class", [ - SpeechClient, - SpeechAsyncClient, -]) -def test_speech_client_from_service_account_file(client_class): - 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") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_speech_client_get_transport_class(): - transport = SpeechClient.get_transport_class() - available_transports = [ - transports.SpeechGrpcTransport, - ] - assert transport in available_transports - - transport = SpeechClient.get_transport_class("grpc") - assert transport == transports.SpeechGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) -@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) -def test_speech_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(SpeechClient, '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(SpeechClient, '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(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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - # 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() - - # 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() - - # 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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc", "true"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (SpeechClient, transports.SpeechGrpcTransport, "grpc", "false"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(SpeechClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechClient)) -@mock.patch.object(SpeechAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(SpeechAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_speech_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) - - 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, - ) - - # 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() - 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, - ) - - # 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() - 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, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_speech_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) - 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, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (SpeechClient, transports.SpeechGrpcTransport, "grpc"), - (SpeechAsyncClient, transports.SpeechGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_speech_client_client_options_credentials_file(client_class, transport_class, transport_name): - # 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) - 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, - ) - - -def test_speech_client_client_options_from_dict(): - with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = SpeechClient( - 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, - ) - - -def test_recognize(transport: str = 'grpc', request_type=cloud_speech.RecognizeRequest): - client = SpeechClient( - 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.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse( - ) - response = client.recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_speech.RecognizeResponse) - - -def test_recognize_from_dict(): - test_recognize(request_type=dict) - - -def test_recognize_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 = SpeechClient( - 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.recognize), - '__call__') as call: - client.recognize() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - -@pytest.mark.asyncio -async def test_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.RecognizeRequest): - client = SpeechAsyncClient( - 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.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse( - )) - response = await client.recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.RecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, cloud_speech.RecognizeResponse) - - -@pytest.mark.asyncio -async def test_recognize_async_from_dict(): - await test_recognize_async(request_type=dict) - - -def test_recognize_flattened(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -def test_recognize_flattened_error(): - client = SpeechClient( - 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.recognize( - cloud_speech.RecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -@pytest.mark.asyncio -async def test_recognize_flattened_async(): - client = SpeechAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = cloud_speech.RecognizeResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(cloud_speech.RecognizeResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -@pytest.mark.asyncio -async def test_recognize_flattened_error_async(): - client = SpeechAsyncClient( - 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.recognize( - cloud_speech.RecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -def test_long_running_recognize(transport: str = 'grpc', request_type=cloud_speech.LongRunningRecognizeRequest): - client = SpeechClient( - 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.long_running_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = operations_pb2.Operation(name='operations/spam') - response = client.long_running_recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -def test_long_running_recognize_from_dict(): - test_long_running_recognize(request_type=dict) - - -def test_long_running_recognize_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 = SpeechClient( - 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.long_running_recognize), - '__call__') as call: - client.long_running_recognize() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - -@pytest.mark.asyncio -async def test_long_running_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.LongRunningRecognizeRequest): - client = SpeechAsyncClient( - 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.long_running_recognize), - '__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.long_running_recognize(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == cloud_speech.LongRunningRecognizeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, future.Future) - - -@pytest.mark.asyncio -async def test_long_running_recognize_async_from_dict(): - await test_long_running_recognize_async(request_type=dict) - - -def test_long_running_recognize_flattened(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.long_running_recognize), - '__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.long_running_recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -def test_long_running_recognize_flattened_error(): - client = SpeechClient( - 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.long_running_recognize( - cloud_speech.LongRunningRecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -@pytest.mark.asyncio -async def test_long_running_recognize_flattened_async(): - client = SpeechAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.long_running_recognize), - '__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.long_running_recognize( - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0].config == cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16) - assert args[0].audio == cloud_speech.RecognitionAudio(content=b'content_blob') - - -@pytest.mark.asyncio -async def test_long_running_recognize_flattened_error_async(): - client = SpeechAsyncClient( - 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.long_running_recognize( - cloud_speech.LongRunningRecognizeRequest(), - config=cloud_speech.RecognitionConfig(encoding=cloud_speech.RecognitionConfig.AudioEncoding.LINEAR16), - audio=cloud_speech.RecognitionAudio(content=b'content_blob'), - ) - - -def test_streaming_recognize(transport: str = 'grpc', request_type=cloud_speech.StreamingRecognizeRequest): - client = SpeechClient( - 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() - requests = [request] - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.streaming_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = iter([cloud_speech.StreamingRecognizeResponse()]) - response = client.streaming_recognize(iter(requests)) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert next(args[0]) == request - - # Establish that the response is the type that we expect. - for message in response: - assert isinstance(message, cloud_speech.StreamingRecognizeResponse) - - -def test_streaming_recognize_from_dict(): - test_streaming_recognize(request_type=dict) - - -@pytest.mark.asyncio -async def test_streaming_recognize_async(transport: str = 'grpc_asyncio', request_type=cloud_speech.StreamingRecognizeRequest): - client = SpeechAsyncClient( - 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() - requests = [request] - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.streaming_recognize), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = mock.Mock(aio.StreamStreamCall, autospec=True) - call.return_value.read = mock.AsyncMock(side_effect=[cloud_speech.StreamingRecognizeResponse()]) - response = await client.streaming_recognize(iter(requests)) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert next(args[0]) == request - - # Establish that the response is the type that we expect. - message = await response.read() - assert isinstance(message, cloud_speech.StreamingRecognizeResponse) - - -@pytest.mark.asyncio -async def test_streaming_recognize_async_from_dict(): - await test_streaming_recognize_async(request_type=dict) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = SpeechClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = SpeechClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.SpeechGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.SpeechGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.SpeechGrpcTransport, - ) - -def test_speech_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.SpeechTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_speech_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.speech_v1p1beta1.services.speech.transports.SpeechTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.SpeechTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'recognize', - 'long_running_recognize', - 'streaming_recognize', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - # Additionally, the LRO client (a property) should - # also raise NotImplementedError - with pytest.raises(NotImplementedError): - transport.operations_client - - -@requires_google_auth_gte_1_25_0 -def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport( - 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', -), - quota_project_id="octopus", - ) - - -@requires_google_auth_lt_1_25_0 -def test_speech_base_transport_with_credentials_file_old_google_auth(): - # 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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - quota_project_id="octopus", - ) - - -def test_speech_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.speech_v1p1beta1.services.speech.transports.SpeechTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.SpeechTransport() - adc.assert_called_once() - - -@requires_google_auth_gte_1_25_0 -def test_speech_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) - SpeechClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id=None, - ) - - -@requires_google_auth_lt_1_25_0 -def test_speech_auth_adc_old_google_auth(): - # 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) - SpeechClient() - adc.assert_called_once_with( - scopes=( 'https://www.googleapis.com/auth/cloud-platform',), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, - ], -) -@requires_google_auth_gte_1_25_0 -def test_speech_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',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.SpeechGrpcTransport, - transports.SpeechGrpcAsyncIOTransport, - ], -) -@requires_google_auth_lt_1_25_0 -def test_speech_transport_auth_adc_old_google_auth(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") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_speech_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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', -), - scopes=["1", "2"], - default_host="speech.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_speech_host_no_port(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com'), - ) - assert client.transport._host == 'speech.googleapis.com:443' - - -def test_speech_host_with_port(): - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='speech.googleapis.com:8000'), - ) - assert client.transport._host == 'speech.googleapis.com:8000' - -def test_speech_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SpeechGrpcTransport( - 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_speech_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.SpeechGrpcAsyncIOTransport( - 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport]) -def test_speech_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=( - 'https://www.googleapis.com/auth/cloud-platform', - ), - 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_speech_grpc_lro_client(): - client = SpeechClient( - 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_speech_grpc_lro_async_client(): - client = SpeechAsyncClient( - 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_custom_class_path(): - project = "squid" - location = "clam" - custom_class = "whelk" - expected = "projects/{project}/locations/{location}/customClasses/{custom_class}".format(project=project, location=location, custom_class=custom_class, ) - actual = SpeechClient.custom_class_path(project, location, custom_class) - assert expected == actual - - -def test_parse_custom_class_path(): - expected = { - "project": "octopus", - "location": "oyster", - "custom_class": "nudibranch", - } - path = SpeechClient.custom_class_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_custom_class_path(path) - assert expected == actual - -def test_phrase_set_path(): - project = "cuttlefish" - location = "mussel" - phrase_set = "winkle" - expected = "projects/{project}/locations/{location}/phraseSets/{phrase_set}".format(project=project, location=location, phrase_set=phrase_set, ) - actual = SpeechClient.phrase_set_path(project, location, phrase_set) - assert expected == actual - - -def test_parse_phrase_set_path(): - expected = { - "project": "nautilus", - "location": "scallop", - "phrase_set": "abalone", - } - path = SpeechClient.phrase_set_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_phrase_set_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = SpeechClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = SpeechClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = SpeechClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = SpeechClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = SpeechClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = SpeechClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = SpeechClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = SpeechClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = SpeechClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = SpeechClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = SpeechClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: - client = SpeechClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.SpeechTransport, '_prep_wrapped_messages') as prep: - transport_class = SpeechClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) diff --git a/tests/unit/gapic/speech_v1/test_speech.py b/tests/unit/gapic/speech_v1/test_speech.py index a7748d3a..0530c165 100644 --- a/tests/unit/gapic/speech_v1/test_speech.py +++ b/tests/unit/gapic/speech_v1/test_speech.py @@ -37,7 +37,6 @@ from google.cloud.speech_v1.services.speech import SpeechAsyncClient from google.cloud.speech_v1.services.speech import SpeechClient from google.cloud.speech_v1.services.speech import transports -from google.cloud.speech_v1.services.speech.transports.base import _API_CORE_VERSION from google.cloud.speech_v1.services.speech.transports.base import _GOOGLE_AUTH_VERSION from google.cloud.speech_v1.types import cloud_speech from google.longrunning import operations_pb2 @@ -46,8 +45,9 @@ import google.auth -# TODO(busunkim): Once google-api-core >= 1.26.0 is required: -# - Delete all the api-core and auth "less than" test cases +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases # - Delete these pytest markers (Make the "greater than or equal to" tests the default). requires_google_auth_lt_1_25_0 = pytest.mark.skipif( packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), @@ -58,16 +58,6 @@ reason="This test requires google-auth >= 1.25.0", ) -requires_api_core_lt_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), - reason="This test requires google-api-core < 1.26.0", -) - -requires_api_core_gte_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), - reason="This test requires google-api-core >= 1.26.0", -) - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -122,6 +112,16 @@ def test_speech_client_from_service_account_info(client_class): assert client.transport._host == "speech.googleapis.com:443" +@pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,]) +def test_speech_client_service_account_always_use_jwt(client_class): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + @pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,]) def test_speech_client_from_service_account_file(client_class): creds = ga_credentials.AnonymousCredentials() @@ -1080,7 +1080,6 @@ def test_speech_transport_auth_adc_old_google_auth(transport_class): (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), ], ) -@requires_api_core_gte_1_26_0 def test_speech_transport_create_channel(transport_class, grpc_helpers): # If credentials and host are not provided, the transport class should use # ADC credentials. @@ -1109,75 +1108,6 @@ def test_speech_transport_create_channel(transport_class, grpc_helpers): ) -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_speech_transport_create_channel_old_api_core(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") - - create_channel.assert_called_with( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_speech_transport_create_channel_user_scopes(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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=["1", "2"], - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - @pytest.mark.parametrize( "transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport], diff --git a/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py b/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py index 60ca9918..893f7c3b 100644 --- a/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py +++ b/tests/unit/gapic/speech_v1p1beta1/test_adaptation.py @@ -35,9 +35,6 @@ from google.cloud.speech_v1p1beta1.services.adaptation import AdaptationClient from google.cloud.speech_v1p1beta1.services.adaptation import pagers from google.cloud.speech_v1p1beta1.services.adaptation import transports -from google.cloud.speech_v1p1beta1.services.adaptation.transports.base import ( - _API_CORE_VERSION, -) from google.cloud.speech_v1p1beta1.services.adaptation.transports.base import ( _GOOGLE_AUTH_VERSION, ) @@ -48,8 +45,9 @@ import google.auth -# TODO(busunkim): Once google-api-core >= 1.26.0 is required: -# - Delete all the api-core and auth "less than" test cases +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases # - Delete these pytest markers (Make the "greater than or equal to" tests the default). requires_google_auth_lt_1_25_0 = pytest.mark.skipif( packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), @@ -60,16 +58,6 @@ reason="This test requires google-auth >= 1.25.0", ) -requires_api_core_lt_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), - reason="This test requires google-api-core < 1.26.0", -) - -requires_api_core_gte_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), - reason="This test requires google-api-core >= 1.26.0", -) - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -127,6 +115,16 @@ def test_adaptation_client_from_service_account_info(client_class): assert client.transport._host == "speech.googleapis.com:443" +@pytest.mark.parametrize("client_class", [AdaptationClient, AdaptationAsyncClient,]) +def test_adaptation_client_service_account_always_use_jwt(client_class): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + @pytest.mark.parametrize("client_class", [AdaptationClient, AdaptationAsyncClient,]) def test_adaptation_client_from_service_account_file(client_class): creds = ga_credentials.AnonymousCredentials() @@ -3135,7 +3133,6 @@ def test_adaptation_transport_auth_adc_old_google_auth(transport_class): (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async), ], ) -@requires_api_core_gte_1_26_0 def test_adaptation_transport_create_channel(transport_class, grpc_helpers): # If credentials and host are not provided, the transport class should use # ADC credentials. @@ -3164,77 +3161,6 @@ def test_adaptation_transport_create_channel(transport_class, grpc_helpers): ) -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AdaptationGrpcTransport, grpc_helpers), - (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_adaptation_transport_create_channel_old_api_core( - 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") - - create_channel.assert_called_with( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AdaptationGrpcTransport, grpc_helpers), - (transports.AdaptationGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_adaptation_transport_create_channel_user_scopes(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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=["1", "2"], - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - @pytest.mark.parametrize( "transport_class", [transports.AdaptationGrpcTransport, transports.AdaptationGrpcAsyncIOTransport], diff --git a/tests/unit/gapic/speech_v1p1beta1/test_speech.py b/tests/unit/gapic/speech_v1p1beta1/test_speech.py index 67af1f43..405fdb37 100644 --- a/tests/unit/gapic/speech_v1p1beta1/test_speech.py +++ b/tests/unit/gapic/speech_v1p1beta1/test_speech.py @@ -37,9 +37,6 @@ from google.cloud.speech_v1p1beta1.services.speech import SpeechAsyncClient from google.cloud.speech_v1p1beta1.services.speech import SpeechClient from google.cloud.speech_v1p1beta1.services.speech import transports -from google.cloud.speech_v1p1beta1.services.speech.transports.base import ( - _API_CORE_VERSION, -) from google.cloud.speech_v1p1beta1.services.speech.transports.base import ( _GOOGLE_AUTH_VERSION, ) @@ -52,8 +49,9 @@ import google.auth -# TODO(busunkim): Once google-api-core >= 1.26.0 is required: -# - Delete all the api-core and auth "less than" test cases +# TODO(busunkim): Once google-auth >= 1.25.0 is required transitively +# through google-api-core: +# - Delete the auth "less than" test cases # - Delete these pytest markers (Make the "greater than or equal to" tests the default). requires_google_auth_lt_1_25_0 = pytest.mark.skipif( packaging.version.parse(_GOOGLE_AUTH_VERSION) >= packaging.version.parse("1.25.0"), @@ -64,16 +62,6 @@ reason="This test requires google-auth >= 1.25.0", ) -requires_api_core_lt_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) >= packaging.version.parse("1.26.0"), - reason="This test requires google-api-core < 1.26.0", -) - -requires_api_core_gte_1_26_0 = pytest.mark.skipif( - packaging.version.parse(_API_CORE_VERSION) < packaging.version.parse("1.26.0"), - reason="This test requires google-api-core >= 1.26.0", -) - def client_cert_source_callback(): return b"cert bytes", b"key bytes" @@ -128,6 +116,16 @@ def test_speech_client_from_service_account_info(client_class): assert client.transport._host == "speech.googleapis.com:443" +@pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,]) +def test_speech_client_service_account_always_use_jwt(client_class): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + client = client_class(credentials=creds) + use_jwt.assert_called_with(True) + + @pytest.mark.parametrize("client_class", [SpeechClient, SpeechAsyncClient,]) def test_speech_client_from_service_account_file(client_class): creds = ga_credentials.AnonymousCredentials() @@ -1086,7 +1084,6 @@ def test_speech_transport_auth_adc_old_google_auth(transport_class): (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), ], ) -@requires_api_core_gte_1_26_0 def test_speech_transport_create_channel(transport_class, grpc_helpers): # If credentials and host are not provided, the transport class should use # ADC credentials. @@ -1115,75 +1112,6 @@ def test_speech_transport_create_channel(transport_class, grpc_helpers): ) -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_speech_transport_create_channel_old_api_core(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") - - create_channel.assert_called_with( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=("https://www.googleapis.com/auth/cloud-platform",), - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.SpeechGrpcTransport, grpc_helpers), - (transports.SpeechGrpcAsyncIOTransport, grpc_helpers_async), - ], -) -@requires_api_core_lt_1_26_0 -def test_speech_transport_create_channel_user_scopes(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( - "speech.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - scopes=["1", "2"], - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - @pytest.mark.parametrize( "transport_class", [transports.SpeechGrpcTransport, transports.SpeechGrpcAsyncIOTransport], From 631372c632019b87fb438ba87329e224bb0bd392 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 22 Jun 2021 23:02:17 +0000 Subject: [PATCH 3/4] fix: require google-api-core>=1.26.0 --- setup.py | 2 +- testing/constraints-3.6.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index fb9797e4..86fb2481 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ # 'Development Status :: 5 - Production/Stable' release_status = "Development Status :: 5 - Production/Stable" dependencies = [ - "google-api-core[grpc] >= 1.22.2, < 2.0.0dev", + "google-api-core[grpc] >= 1.26.0, <2.0.0dev"," "libcst >= 0.2.5", "proto-plus >= 1.4.0", "packaging >= 14.3", diff --git a/testing/constraints-3.6.txt b/testing/constraints-3.6.txt index 7f0da877..bab82048 100644 --- a/testing/constraints-3.6.txt +++ b/testing/constraints-3.6.txt @@ -5,7 +5,7 @@ # # e.g., if setup.py has "foo >= 1.14.0, < 2.0.0dev", # Then this file should have foo==1.14.0 -google-api-core==1.22.2 +google-api-core==1.26.0 libcst==0.2.5 proto-plus==1.4.0 google-auth==1.24.0 # TODO: Remove when google-auth >= 1.25.0 is required transitively through google-api-core From 61e9bddbb451026015a218725683ce443232ed69 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Tue, 22 Jun 2021 23:11:24 +0000 Subject: [PATCH 4/4] fix: fix typo in setup.py --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 86fb2481..a944d6bb 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ # 'Development Status :: 5 - Production/Stable' release_status = "Development Status :: 5 - Production/Stable" dependencies = [ - "google-api-core[grpc] >= 1.26.0, <2.0.0dev"," + "google-api-core[grpc] >= 1.26.0, <2.0.0dev", "libcst >= 0.2.5", "proto-plus >= 1.4.0", "packaging >= 14.3",