From 74b8975f96e4fa24a9c9a590513c95e022cc2067 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Mon, 19 Feb 2024 20:53:27 +0000 Subject: [PATCH 1/2] feat: add session token support for Autocomplete (New) sessions that end with a call to Address Validation feat: add new fields to USPS data docs: update proto field descriptions PiperOrigin-RevId: 608369029 Source-Link: https://github.com/googleapis/googleapis/commit/5ff3e5298f3e330c09bd1690090f5c24f1540e86 Source-Link: https://github.com/googleapis/googleapis-gen/commit/c1828358be412ba02e45bfbae3afc2b3dadd5d32 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImMxODI4MzU4YmU0MTJiYTAyZTQ1YmZiYWUzYWZjMmIzZGFkZDVkMzIifQ== --- .../v1/.coveragerc | 13 + .../google-maps-addressvalidation/v1/.flake8 | 33 + .../v1/MANIFEST.in | 2 + .../v1/README.rst | 49 + .../v1/docs/_static/custom.css | 3 + .../address_validation.rst | 6 + .../docs/addressvalidation_v1/services_.rst | 6 + .../v1/docs/addressvalidation_v1/types_.rst | 6 + .../v1/docs/conf.py | 376 ++++ .../v1/docs/index.rst | 7 + .../google/maps/addressvalidation/__init__.py | 55 + .../maps/addressvalidation/gapic_version.py | 16 + .../v1/google/maps/addressvalidation/py.typed | 2 + .../maps/addressvalidation_v1/__init__.py | 56 + .../addressvalidation_v1/gapic_metadata.json | 58 + .../addressvalidation_v1/gapic_version.py | 16 + .../google/maps/addressvalidation_v1/py.typed | 2 + .../addressvalidation_v1/services/__init__.py | 15 + .../services/address_validation/__init__.py | 22 + .../address_validation/async_client.py | 392 ++++ .../services/address_validation/client.py | 737 +++++++ .../address_validation/transports/__init__.py | 38 + .../address_validation/transports/base.py | 165 ++ .../address_validation/transports/grpc.py | 295 +++ .../transports/grpc_asyncio.py | 294 +++ .../address_validation/transports/rest.py | 421 ++++ .../addressvalidation_v1/types/__init__.py | 56 + .../addressvalidation_v1/types/address.py | 244 +++ .../types/address_validation_service.py | 413 ++++ .../addressvalidation_v1/types/geocode.py | 132 ++ .../addressvalidation_v1/types/metadata_.py | 76 + .../addressvalidation_v1/types/usps_data.py | 493 +++++ .../google-maps-addressvalidation/v1/mypy.ini | 3 + .../v1/noxfile.py | 253 +++ ...ation_provide_validation_feedback_async.py | 53 + ...dation_provide_validation_feedback_sync.py | 53 + ...dress_validation_validate_address_async.py | 51 + ...ddress_validation_validate_address_sync.py | 51 + ...data_google.maps.addressvalidation.v1.json | 321 +++ .../fixup_addressvalidation_v1_keywords.py | 177 ++ .../google-maps-addressvalidation/v1/setup.py | 92 + .../v1/testing/constraints-3.10.txt | 7 + .../v1/testing/constraints-3.11.txt | 7 + .../v1/testing/constraints-3.12.txt | 7 + .../v1/testing/constraints-3.7.txt | 11 + .../v1/testing/constraints-3.8.txt | 7 + .../v1/testing/constraints-3.9.txt | 7 + .../v1/tests/__init__.py | 16 + .../v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../gapic/addressvalidation_v1/__init__.py | 16 + .../test_address_validation.py | 1944 +++++++++++++++++ 52 files changed, 7607 insertions(+) create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/.flake8 create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/README.rst create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/setup.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py create mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc b/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc new file mode 100644 index 000000000000..e4692ea29e6d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/maps/addressvalidation/__init__.py + google/maps/addressvalidation/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 b/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 new file mode 100644 index 000000000000..29227d4cf419 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 @@ -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 +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in b/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in new file mode 100644 index 000000000000..6d21915b6647 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/maps/addressvalidation *.py +recursive-include google/maps/addressvalidation_v1 *.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/README.rst b/owl-bot-staging/google-maps-addressvalidation/v1/README.rst new file mode 100644 index 000000000000..6bce085c3115 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Maps Addressvalidation 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 Maps Addressvalidation 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/google-maps-addressvalidation/v1/docs/_static/custom.css b/owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css new file mode 100644 index 000000000000..06423be0b592 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css @@ -0,0 +1,3 @@ +dl.field-list > dt { + min-width: 100px +} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst new file mode 100644 index 000000000000..bfcddd27291d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst @@ -0,0 +1,6 @@ +AddressValidation +----------------------------------- + +.. automodule:: google.maps.addressvalidation_v1.services.address_validation + :members: + :inherited-members: diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst new file mode 100644 index 000000000000..44fb49f7a1cb --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Maps Addressvalidation v1 API +================================================= +.. toctree:: + :maxdepth: 2 + + address_validation diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst new file mode 100644 index 000000000000..454488a7c78b --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Maps Addressvalidation v1 API +============================================== + +.. automodule:: google.maps.addressvalidation_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py b/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py new file mode 100644 index 000000000000..df0d7356b9b9 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# google-maps-addressvalidation documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-maps-addressvalidation" +copyright = u"2023, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Maps 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-maps-addressvalidation-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-maps-addressvalidation.tex", + u"google-maps-addressvalidation Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-maps-addressvalidation", + u"Google Maps Addressvalidation Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-maps-addressvalidation", + u"google-maps-addressvalidation Documentation", + author, + "google-maps-addressvalidation", + "GAPIC library for Google Maps Addressvalidation 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/google-maps-addressvalidation/v1/docs/index.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst new file mode 100644 index 000000000000..de0c00b3a9b4 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + addressvalidation_v1/services + addressvalidation_v1/types diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py new file mode 100644 index 000000000000..76a7b79861a1 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.maps.addressvalidation import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.maps.addressvalidation_v1.services.address_validation.client import AddressValidationClient +from google.maps.addressvalidation_v1.services.address_validation.async_client import AddressValidationAsyncClient + +from google.maps.addressvalidation_v1.types.address import Address +from google.maps.addressvalidation_v1.types.address import AddressComponent +from google.maps.addressvalidation_v1.types.address import ComponentName +from google.maps.addressvalidation_v1.types.address_validation_service import ProvideValidationFeedbackRequest +from google.maps.addressvalidation_v1.types.address_validation_service import ProvideValidationFeedbackResponse +from google.maps.addressvalidation_v1.types.address_validation_service import ValidateAddressRequest +from google.maps.addressvalidation_v1.types.address_validation_service import ValidateAddressResponse +from google.maps.addressvalidation_v1.types.address_validation_service import ValidationResult +from google.maps.addressvalidation_v1.types.address_validation_service import Verdict +from google.maps.addressvalidation_v1.types.geocode import Geocode +from google.maps.addressvalidation_v1.types.geocode import PlusCode +from google.maps.addressvalidation_v1.types.metadata_ import AddressMetadata +from google.maps.addressvalidation_v1.types.usps_data import UspsAddress +from google.maps.addressvalidation_v1.types.usps_data import UspsData + +__all__ = ('AddressValidationClient', + 'AddressValidationAsyncClient', + 'Address', + 'AddressComponent', + 'ComponentName', + 'ProvideValidationFeedbackRequest', + 'ProvideValidationFeedbackResponse', + 'ValidateAddressRequest', + 'ValidateAddressResponse', + 'ValidationResult', + 'Verdict', + 'Geocode', + 'PlusCode', + 'AddressMetadata', + 'UspsAddress', + 'UspsData', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py new file mode 100644 index 000000000000..360a0d13ebdd --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed new file mode 100644 index 000000000000..1e46c59c8e22 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-maps-addressvalidation package uses inline types. diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py new file mode 100644 index 000000000000..6ba74e7a6bb6 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from google.maps.addressvalidation_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.address_validation import AddressValidationClient +from .services.address_validation import AddressValidationAsyncClient + +from .types.address import Address +from .types.address import AddressComponent +from .types.address import ComponentName +from .types.address_validation_service import ProvideValidationFeedbackRequest +from .types.address_validation_service import ProvideValidationFeedbackResponse +from .types.address_validation_service import ValidateAddressRequest +from .types.address_validation_service import ValidateAddressResponse +from .types.address_validation_service import ValidationResult +from .types.address_validation_service import Verdict +from .types.geocode import Geocode +from .types.geocode import PlusCode +from .types.metadata_ import AddressMetadata +from .types.usps_data import UspsAddress +from .types.usps_data import UspsData + +__all__ = ( + 'AddressValidationAsyncClient', +'Address', +'AddressComponent', +'AddressMetadata', +'AddressValidationClient', +'ComponentName', +'Geocode', +'PlusCode', +'ProvideValidationFeedbackRequest', +'ProvideValidationFeedbackResponse', +'UspsAddress', +'UspsData', +'ValidateAddressRequest', +'ValidateAddressResponse', +'ValidationResult', +'Verdict', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json new file mode 100644 index 000000000000..c521c066be76 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json @@ -0,0 +1,58 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.maps.addressvalidation_v1", + "protoPackage": "google.maps.addressvalidation.v1", + "schema": "1.0", + "services": { + "AddressValidation": { + "clients": { + "grpc": { + "libraryClient": "AddressValidationClient", + "rpcs": { + "ProvideValidationFeedback": { + "methods": [ + "provide_validation_feedback" + ] + }, + "ValidateAddress": { + "methods": [ + "validate_address" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AddressValidationAsyncClient", + "rpcs": { + "ProvideValidationFeedback": { + "methods": [ + "provide_validation_feedback" + ] + }, + "ValidateAddress": { + "methods": [ + "validate_address" + ] + } + } + }, + "rest": { + "libraryClient": "AddressValidationClient", + "rpcs": { + "ProvideValidationFeedback": { + "methods": [ + "provide_validation_feedback" + ] + }, + "ValidateAddress": { + "methods": [ + "validate_address" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py new file mode 100644 index 000000000000..360a0d13ebdd --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed new file mode 100644 index 000000000000..1e46c59c8e22 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-maps-addressvalidation package uses inline types. diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py new file mode 100644 index 000000000000..89a37dc92c5a --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py new file mode 100644 index 000000000000..0058d06ca2d8 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .client import AddressValidationClient +from .async_client import AddressValidationAsyncClient + +__all__ = ( + 'AddressValidationClient', + 'AddressValidationAsyncClient', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py new file mode 100644 index 000000000000..e3500e42f9fa --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py @@ -0,0 +1,392 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.maps.addressvalidation_v1 import gapic_version as package_version + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.maps.addressvalidation_v1.types import address_validation_service +from .transports.base import AddressValidationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import AddressValidationGrpcAsyncIOTransport +from .client import AddressValidationClient + + +class AddressValidationAsyncClient: + """The service for validating addresses.""" + + _client: AddressValidationClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = AddressValidationClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AddressValidationClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = AddressValidationClient._DEFAULT_UNIVERSE + + common_billing_account_path = staticmethod(AddressValidationClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(AddressValidationClient.parse_common_billing_account_path) + common_folder_path = staticmethod(AddressValidationClient.common_folder_path) + parse_common_folder_path = staticmethod(AddressValidationClient.parse_common_folder_path) + common_organization_path = staticmethod(AddressValidationClient.common_organization_path) + parse_common_organization_path = staticmethod(AddressValidationClient.parse_common_organization_path) + common_project_path = staticmethod(AddressValidationClient.common_project_path) + parse_common_project_path = staticmethod(AddressValidationClient.parse_common_project_path) + common_location_path = staticmethod(AddressValidationClient.common_location_path) + parse_common_location_path = staticmethod(AddressValidationClient.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: + AddressValidationAsyncClient: The constructed client. + """ + return AddressValidationClient.from_service_account_info.__func__(AddressValidationAsyncClient, 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: + AddressValidationAsyncClient: The constructed client. + """ + return AddressValidationClient.from_service_account_file.__func__(AddressValidationAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return AddressValidationClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> AddressValidationTransport: + """Returns the transport used by the client instance. + + Returns: + AddressValidationTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = functools.partial(type(AddressValidationClient).get_transport_class, type(AddressValidationClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, AddressValidationTransport] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the address validation async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.AddressValidationTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = AddressValidationClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def validate_address(self, + request: Optional[Union[address_validation_service.ValidateAddressRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> address_validation_service.ValidateAddressResponse: + r"""Validates an address. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.maps import addressvalidation_v1 + + async def sample_validate_address(): + # Create a client + client = addressvalidation_v1.AddressValidationAsyncClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ValidateAddressRequest( + ) + + # Make the request + response = await client.validate_address(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.maps.addressvalidation_v1.types.ValidateAddressRequest, dict]]): + The request object. The request for validating an + address. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.maps.addressvalidation_v1.types.ValidateAddressResponse: + The response to an address validation + request. + + """ + # Create or coerce a protobuf request object. + request = address_validation_service.ValidateAddressRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.validate_address, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def provide_validation_feedback(self, + request: Optional[Union[address_validation_service.ProvideValidationFeedbackRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> address_validation_service.ProvideValidationFeedbackResponse: + r"""Feedback about the outcome of the sequence of validation + attempts. This should be the last call made after a sequence of + validation calls for the same address, and should be called once + the transaction is concluded. This should only be sent once for + the sequence of ``ValidateAddress`` requests needed to validate + an address fully. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.maps import addressvalidation_v1 + + async def sample_provide_validation_feedback(): + # Create a client + client = addressvalidation_v1.AddressValidationAsyncClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ProvideValidationFeedbackRequest( + conclusion="UNUSED", + response_id="response_id_value", + ) + + # Make the request + response = await client.provide_validation_feedback(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest, dict]]): + The request object. The request for sending validation + feedback. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse: + The response for validation feedback. + + The response is empty if the feedback is + sent successfully. + + """ + # Create or coerce a protobuf request object. + request = address_validation_service.ProvideValidationFeedbackRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.provide_validation_feedback, + default_timeout=None, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "AddressValidationAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AddressValidationAsyncClient", +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py new file mode 100644 index 000000000000..329d2603d9da --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py @@ -0,0 +1,737 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +import warnings + +from google.maps.addressvalidation_v1 import gapic_version as package_version + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +from google.maps.addressvalidation_v1.types import address_validation_service +from .transports.base import AddressValidationTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import AddressValidationGrpcTransport +from .transports.grpc_asyncio import AddressValidationGrpcAsyncIOTransport +from .transports.rest import AddressValidationRestTransport + + +class AddressValidationClientMeta(type): + """Metaclass for the AddressValidation 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[AddressValidationTransport]] + _transport_registry["grpc"] = AddressValidationGrpcTransport + _transport_registry["grpc_asyncio"] = AddressValidationGrpcAsyncIOTransport + _transport_registry["rest"] = AddressValidationRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[AddressValidationTransport]: + """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 AddressValidationClient(metaclass=AddressValidationClientMeta): + """The service for validating addresses.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "addressvalidation.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "addressvalidation.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + AddressValidationClient: 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: + AddressValidationClient: 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) -> AddressValidationTransport: + """Returns the transport used by the client instance. + + Returns: + AddressValidationTransport: 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 {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + _default_universe = AddressValidationClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + api_endpoint = AddressValidationClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + return api_endpoint + + @staticmethod + def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = AddressValidationClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + @staticmethod + def _compare_universes(client_universe: str, + credentials: ga_credentials.Credentials) -> bool: + """Returns True iff the universe domains used by the client and credentials match. + + Args: + client_universe (str): The universe domain configured via the client options. + credentials (ga_credentials.Credentials): The credentials being used in the client. + + Returns: + bool: True iff client_universe matches the universe in credentials. + + Raises: + ValueError: when client_universe does not match the universe in credentials. + """ + + default_universe = AddressValidationClient._DEFAULT_UNIVERSE + credentials_universe = getattr(credentials, "universe_domain", default_universe) + + if client_universe != credentials_universe: + raise ValueError("The configured universe domain " + f"({client_universe}) does not match the universe domain " + f"found in the credentials ({credentials_universe}). " + "If you haven't configured the universe domain explicitly, " + f"`{default_universe}` is the default.") + return True + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + self._is_universe_domain_valid = (self._is_universe_domain_valid or + AddressValidationClient._compare_universes(self.universe_domain, self.transport._credentials)) + return self._is_universe_domain_valid + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, AddressValidationTransport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the address validation 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, AddressValidationTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + + universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + + self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = AddressValidationClient._read_environment_variables() + self._client_cert_source = AddressValidationClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) + self._universe_domain = AddressValidationClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance(transport, AddressValidationTransport) + if transport_provided: + # transport is a AddressValidationTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(AddressValidationTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = (self._api_endpoint or + AddressValidationClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint)) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(cast(str, transport)) + self._transport = Transport( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + def validate_address(self, + request: Optional[Union[address_validation_service.ValidateAddressRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> address_validation_service.ValidateAddressResponse: + r"""Validates an address. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.maps import addressvalidation_v1 + + def sample_validate_address(): + # Create a client + client = addressvalidation_v1.AddressValidationClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ValidateAddressRequest( + ) + + # Make the request + response = client.validate_address(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.maps.addressvalidation_v1.types.ValidateAddressRequest, dict]): + The request object. The request for validating an + address. + 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.maps.addressvalidation_v1.types.ValidateAddressResponse: + The response to an address validation + request. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a address_validation_service.ValidateAddressRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, address_validation_service.ValidateAddressRequest): + request = address_validation_service.ValidateAddressRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.validate_address] + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def provide_validation_feedback(self, + request: Optional[Union[address_validation_service.ProvideValidationFeedbackRequest, dict]] = None, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> address_validation_service.ProvideValidationFeedbackResponse: + r"""Feedback about the outcome of the sequence of validation + attempts. This should be the last call made after a sequence of + validation calls for the same address, and should be called once + the transaction is concluded. This should only be sent once for + the sequence of ``ValidateAddress`` requests needed to validate + an address fully. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.maps import addressvalidation_v1 + + def sample_provide_validation_feedback(): + # Create a client + client = addressvalidation_v1.AddressValidationClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ProvideValidationFeedbackRequest( + conclusion="UNUSED", + response_id="response_id_value", + ) + + # Make the request + response = client.provide_validation_feedback(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest, dict]): + The request object. The request for sending validation + feedback. + 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.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse: + The response for validation feedback. + + The response is empty if the feedback is + sent successfully. + + """ + # Create or coerce a protobuf request object. + # Minor optimization to avoid making a copy if the user passes + # in a address_validation_service.ProvideValidationFeedbackRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, address_validation_service.ProvideValidationFeedbackRequest): + request = address_validation_service.ProvideValidationFeedbackRequest(request) + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.provide_validation_feedback] + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "AddressValidationClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__all__ = ( + "AddressValidationClient", +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py new file mode 100644 index 000000000000..5d08151012a0 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import AddressValidationTransport +from .grpc import AddressValidationGrpcTransport +from .grpc_asyncio import AddressValidationGrpcAsyncIOTransport +from .rest import AddressValidationRestTransport +from .rest import AddressValidationRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[AddressValidationTransport]] +_transport_registry['grpc'] = AddressValidationGrpcTransport +_transport_registry['grpc_asyncio'] = AddressValidationGrpcAsyncIOTransport +_transport_registry['rest'] = AddressValidationRestTransport + +__all__ = ( + 'AddressValidationTransport', + 'AddressValidationGrpcTransport', + 'AddressValidationGrpcAsyncIOTransport', + 'AddressValidationRestTransport', + 'AddressValidationRestInterceptor', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py new file mode 100644 index 000000000000..264b5c31f267 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py @@ -0,0 +1,165 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +from google.maps.addressvalidation_v1 import gapic_version as package_version + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.maps.addressvalidation_v1.types import address_validation_service + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class AddressValidationTransport(abc.ABC): + """Abstract transport class for AddressValidation.""" + + AUTH_SCOPES = ( + ) + + DEFAULT_HOST: str = 'addressvalidation.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'addressvalidation.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.validate_address: gapic_v1.method.wrap_method( + self.validate_address, + default_timeout=None, + client_info=client_info, + ), + self.provide_validation_feedback: gapic_v1.method.wrap_method( + self.provide_validation_feedback, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def validate_address(self) -> Callable[ + [address_validation_service.ValidateAddressRequest], + Union[ + address_validation_service.ValidateAddressResponse, + Awaitable[address_validation_service.ValidateAddressResponse] + ]]: + raise NotImplementedError() + + @property + def provide_validation_feedback(self) -> Callable[ + [address_validation_service.ProvideValidationFeedbackRequest], + Union[ + address_validation_service.ProvideValidationFeedbackResponse, + Awaitable[address_validation_service.ProvideValidationFeedbackResponse] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'AddressValidationTransport', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py new file mode 100644 index 000000000000..82b8e24a4164 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py @@ -0,0 +1,295 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.maps.addressvalidation_v1.types import address_validation_service +from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO + + +class AddressValidationGrpcTransport(AddressValidationTransport): + """gRPC backend transport for AddressValidation. + + The service for validating addresses. + + 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 = 'addressvalidation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'addressvalidation.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'addressvalidation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def validate_address(self) -> Callable[ + [address_validation_service.ValidateAddressRequest], + address_validation_service.ValidateAddressResponse]: + r"""Return a callable for the validate address method over gRPC. + + Validates an address. + + Returns: + Callable[[~.ValidateAddressRequest], + ~.ValidateAddressResponse]: + 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 'validate_address' not in self._stubs: + self._stubs['validate_address'] = self.grpc_channel.unary_unary( + '/google.maps.addressvalidation.v1.AddressValidation/ValidateAddress', + request_serializer=address_validation_service.ValidateAddressRequest.serialize, + response_deserializer=address_validation_service.ValidateAddressResponse.deserialize, + ) + return self._stubs['validate_address'] + + @property + def provide_validation_feedback(self) -> Callable[ + [address_validation_service.ProvideValidationFeedbackRequest], + address_validation_service.ProvideValidationFeedbackResponse]: + r"""Return a callable for the provide validation feedback method over gRPC. + + Feedback about the outcome of the sequence of validation + attempts. This should be the last call made after a sequence of + validation calls for the same address, and should be called once + the transaction is concluded. This should only be sent once for + the sequence of ``ValidateAddress`` requests needed to validate + an address fully. + + Returns: + Callable[[~.ProvideValidationFeedbackRequest], + ~.ProvideValidationFeedbackResponse]: + 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 'provide_validation_feedback' not in self._stubs: + self._stubs['provide_validation_feedback'] = self.grpc_channel.unary_unary( + '/google.maps.addressvalidation.v1.AddressValidation/ProvideValidationFeedback', + request_serializer=address_validation_service.ProvideValidationFeedbackRequest.serialize, + response_deserializer=address_validation_service.ProvideValidationFeedbackResponse.deserialize, + ) + return self._stubs['provide_validation_feedback'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'AddressValidationGrpcTransport', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py new file mode 100644 index 000000000000..6f28e6b8d385 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py @@ -0,0 +1,294 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.maps.addressvalidation_v1.types import address_validation_service +from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO +from .grpc import AddressValidationGrpcTransport + + +class AddressValidationGrpcAsyncIOTransport(AddressValidationTransport): + """gRPC AsyncIO backend transport for AddressValidation. + + The service for validating addresses. + + 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 = 'addressvalidation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'addressvalidation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'addressvalidation.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def validate_address(self) -> Callable[ + [address_validation_service.ValidateAddressRequest], + Awaitable[address_validation_service.ValidateAddressResponse]]: + r"""Return a callable for the validate address method over gRPC. + + Validates an address. + + Returns: + Callable[[~.ValidateAddressRequest], + Awaitable[~.ValidateAddressResponse]]: + 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 'validate_address' not in self._stubs: + self._stubs['validate_address'] = self.grpc_channel.unary_unary( + '/google.maps.addressvalidation.v1.AddressValidation/ValidateAddress', + request_serializer=address_validation_service.ValidateAddressRequest.serialize, + response_deserializer=address_validation_service.ValidateAddressResponse.deserialize, + ) + return self._stubs['validate_address'] + + @property + def provide_validation_feedback(self) -> Callable[ + [address_validation_service.ProvideValidationFeedbackRequest], + Awaitable[address_validation_service.ProvideValidationFeedbackResponse]]: + r"""Return a callable for the provide validation feedback method over gRPC. + + Feedback about the outcome of the sequence of validation + attempts. This should be the last call made after a sequence of + validation calls for the same address, and should be called once + the transaction is concluded. This should only be sent once for + the sequence of ``ValidateAddress`` requests needed to validate + an address fully. + + Returns: + Callable[[~.ProvideValidationFeedbackRequest], + Awaitable[~.ProvideValidationFeedbackResponse]]: + 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 'provide_validation_feedback' not in self._stubs: + self._stubs['provide_validation_feedback'] = self.grpc_channel.unary_unary( + '/google.maps.addressvalidation.v1.AddressValidation/ProvideValidationFeedback', + request_serializer=address_validation_service.ProvideValidationFeedbackRequest.serialize, + response_deserializer=address_validation_service.ProvideValidationFeedbackResponse.deserialize, + ) + return self._stubs['provide_validation_feedback'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'AddressValidationGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py new file mode 100644 index 000000000000..1dfbd2a3e525 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py @@ -0,0 +1,421 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + + +from google.maps.addressvalidation_v1.types import address_validation_service + +from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class AddressValidationRestInterceptor: + """Interceptor for AddressValidation. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the AddressValidationRestTransport. + + .. code-block:: python + class MyCustomAddressValidationInterceptor(AddressValidationRestInterceptor): + def pre_provide_validation_feedback(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_provide_validation_feedback(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_validate_address(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_validate_address(self, response): + logging.log(f"Received response: {response}") + return response + + transport = AddressValidationRestTransport(interceptor=MyCustomAddressValidationInterceptor()) + client = AddressValidationClient(transport=transport) + + + """ + def pre_provide_validation_feedback(self, request: address_validation_service.ProvideValidationFeedbackRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[address_validation_service.ProvideValidationFeedbackRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for provide_validation_feedback + + Override in a subclass to manipulate the request or metadata + before they are sent to the AddressValidation server. + """ + return request, metadata + + def post_provide_validation_feedback(self, response: address_validation_service.ProvideValidationFeedbackResponse) -> address_validation_service.ProvideValidationFeedbackResponse: + """Post-rpc interceptor for provide_validation_feedback + + Override in a subclass to manipulate the response + after it is returned by the AddressValidation server but before + it is returned to user code. + """ + return response + def pre_validate_address(self, request: address_validation_service.ValidateAddressRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[address_validation_service.ValidateAddressRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for validate_address + + Override in a subclass to manipulate the request or metadata + before they are sent to the AddressValidation server. + """ + return request, metadata + + def post_validate_address(self, response: address_validation_service.ValidateAddressResponse) -> address_validation_service.ValidateAddressResponse: + """Post-rpc interceptor for validate_address + + Override in a subclass to manipulate the response + after it is returned by the AddressValidation server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class AddressValidationRestStub: + _session: AuthorizedSession + _host: str + _interceptor: AddressValidationRestInterceptor + + +class AddressValidationRestTransport(AddressValidationTransport): + """REST backend transport for AddressValidation. + + The service for validating addresses. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'addressvalidation.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[ + ], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = 'https', + interceptor: Optional[AddressValidationRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'addressvalidation.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or AddressValidationRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ProvideValidationFeedback(AddressValidationRestStub): + def __hash__(self): + return hash("ProvideValidationFeedback") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: address_validation_service.ProvideValidationFeedbackRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> address_validation_service.ProvideValidationFeedbackResponse: + r"""Call the provide validation + feedback method over HTTP. + + Args: + request (~.address_validation_service.ProvideValidationFeedbackRequest): + The request object. The request for sending validation + feedback. + 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: + ~.address_validation_service.ProvideValidationFeedbackResponse: + The response for validation feedback. + + The response is empty if the feedback is + sent successfully. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1:provideValidationFeedback', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_provide_validation_feedback(request, metadata) + pb_request = address_validation_service.ProvideValidationFeedbackRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = address_validation_service.ProvideValidationFeedbackResponse() + pb_resp = address_validation_service.ProvideValidationFeedbackResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_provide_validation_feedback(resp) + return resp + + class _ValidateAddress(AddressValidationRestStub): + def __hash__(self): + return hash("ValidateAddress") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: address_validation_service.ValidateAddressRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> address_validation_service.ValidateAddressResponse: + r"""Call the validate address method over HTTP. + + Args: + request (~.address_validation_service.ValidateAddressRequest): + The request object. The request for validating an + address. + 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: + ~.address_validation_service.ValidateAddressResponse: + The response to an address validation + request. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1:validateAddress', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_validate_address(request, metadata) + pb_request = address_validation_service.ValidateAddressRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = address_validation_service.ValidateAddressResponse() + pb_resp = address_validation_service.ValidateAddressResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_validate_address(resp) + return resp + + @property + def provide_validation_feedback(self) -> Callable[ + [address_validation_service.ProvideValidationFeedbackRequest], + address_validation_service.ProvideValidationFeedbackResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ProvideValidationFeedback(self._session, self._host, self._interceptor) # type: ignore + + @property + def validate_address(self) -> Callable[ + [address_validation_service.ValidateAddressRequest], + address_validation_service.ValidateAddressResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ValidateAddress(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'AddressValidationRestTransport', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py new file mode 100644 index 000000000000..33b0cf3c0a05 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from .address import ( + Address, + AddressComponent, + ComponentName, +) +from .address_validation_service import ( + ProvideValidationFeedbackRequest, + ProvideValidationFeedbackResponse, + ValidateAddressRequest, + ValidateAddressResponse, + ValidationResult, + Verdict, +) +from .geocode import ( + Geocode, + PlusCode, +) +from .metadata_ import ( + AddressMetadata, +) +from .usps_data import ( + UspsAddress, + UspsData, +) + +__all__ = ( + 'Address', + 'AddressComponent', + 'ComponentName', + 'ProvideValidationFeedbackRequest', + 'ProvideValidationFeedbackResponse', + 'ValidateAddressRequest', + 'ValidateAddressResponse', + 'ValidationResult', + 'Verdict', + 'Geocode', + 'PlusCode', + 'AddressMetadata', + 'UspsAddress', + 'UspsData', +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py new file mode 100644 index 000000000000..8e6e77e34d1a --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py @@ -0,0 +1,244 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.type import postal_address_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.maps.addressvalidation.v1', + manifest={ + 'Address', + 'AddressComponent', + 'ComponentName', + }, +) + + +class Address(proto.Message): + r"""Details of the post-processed address. Post-processing + includes correcting misspelled parts of the address, replacing + incorrect parts, and inferring missing parts. + + Attributes: + formatted_address (str): + The post-processed address, formatted as a + single-line address following the address + formatting rules of the region where the address + is located. + postal_address (google.type.postal_address_pb2.PostalAddress): + The post-processed address represented as a + postal address. + address_components (MutableSequence[google.maps.addressvalidation_v1.types.AddressComponent]): + Unordered list. The individual address + components of the formatted and corrected + address, along with validation information. This + provides information on the validation status of + the individual components. + + Address components are not ordered in a + particular way. Do not make any assumptions on + the ordering of the address components in the + list. + missing_component_types (MutableSequence[str]): + The types of components that were expected to be present in + a correctly formatted mailing address but were not found in + the input AND could not be inferred. Components of this type + are not present in ``formatted_address``, + ``postal_address``, or ``address_components``. An example + might be ``['street_number', 'route']`` for an input like + "Boulder, Colorado, 80301, USA". The list of possible types + can be found + `here `__. + unconfirmed_component_types (MutableSequence[str]): + The types of the components that are present in the + ``address_components`` but could not be confirmed to be + correct. This field is provided for the sake of convenience: + its contents are equivalent to iterating through the + ``address_components`` to find the types of all the + components where the + [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level] + is not + [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED] + or the + [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred] + flag is not set to ``true``. The list of possible types can + be found + `here `__. + unresolved_tokens (MutableSequence[str]): + Any tokens in the input that could not be resolved. This + might be an input that was not recognized as a valid part of + an address (for example in an input like "123235253253 Main + St, San Francisco, CA, 94105", the unresolved tokens may + look like ``["123235253253"]`` since that does not look like + a valid street number. + """ + + formatted_address: str = proto.Field( + proto.STRING, + number=2, + ) + postal_address: postal_address_pb2.PostalAddress = proto.Field( + proto.MESSAGE, + number=3, + message=postal_address_pb2.PostalAddress, + ) + address_components: MutableSequence['AddressComponent'] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message='AddressComponent', + ) + missing_component_types: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=5, + ) + unconfirmed_component_types: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=6, + ) + unresolved_tokens: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=7, + ) + + +class AddressComponent(proto.Message): + r"""Represents an address component, such as a street, city, or + state. + + Attributes: + component_name (google.maps.addressvalidation_v1.types.ComponentName): + The name for this component. + component_type (str): + The type of the address component. See `Table 2: Additional + types returned by the Places + service `__ + for a list of possible types. + confirmation_level (google.maps.addressvalidation_v1.types.AddressComponent.ConfirmationLevel): + Indicates the level of certainty that we have + that the component is correct. + inferred (bool): + Indicates that the component was not part of + the input, but we inferred it for the address + location and believe it should be provided for a + complete address. + spell_corrected (bool): + Indicates a correction to a misspelling in + the component name. The API does not always + flag changes from one spelling variant to + another, such as when changing "centre" to + "center". It also does not always flag common + misspellings, such as when changing + "Amphitheater Pkwy" to "Amphitheatre Pkwy". + replaced (bool): + Indicates the name of the component was + replaced with a completely different one, for + example a wrong postal code being replaced with + one that is correct for the address. This is not + a cosmetic change, the input component has been + changed to a different one. + unexpected (bool): + Indicates an address component that is not + expected to be present in a postal address for + the given region. We have retained it only + because it was part of the input. + """ + class ConfirmationLevel(proto.Enum): + r"""The different possible values for confirmation levels. + + Values: + CONFIRMATION_LEVEL_UNSPECIFIED (0): + Default value. This value is unused. + CONFIRMED (1): + We were able to verify that this component + exists and makes sense in the context of the + rest of the address. + UNCONFIRMED_BUT_PLAUSIBLE (2): + This component could not be confirmed, but it + is plausible that it exists. For example, a + street number within a known valid range of + numbers on a street where specific house numbers + are not known. + UNCONFIRMED_AND_SUSPICIOUS (3): + This component was not confirmed and is + likely to be wrong. For example, a neighborhood + that does not fit the rest of the address. + """ + CONFIRMATION_LEVEL_UNSPECIFIED = 0 + CONFIRMED = 1 + UNCONFIRMED_BUT_PLAUSIBLE = 2 + UNCONFIRMED_AND_SUSPICIOUS = 3 + + component_name: 'ComponentName' = proto.Field( + proto.MESSAGE, + number=1, + message='ComponentName', + ) + component_type: str = proto.Field( + proto.STRING, + number=2, + ) + confirmation_level: ConfirmationLevel = proto.Field( + proto.ENUM, + number=3, + enum=ConfirmationLevel, + ) + inferred: bool = proto.Field( + proto.BOOL, + number=4, + ) + spell_corrected: bool = proto.Field( + proto.BOOL, + number=5, + ) + replaced: bool = proto.Field( + proto.BOOL, + number=6, + ) + unexpected: bool = proto.Field( + proto.BOOL, + number=7, + ) + + +class ComponentName(proto.Message): + r"""A wrapper for the name of the component. + + Attributes: + text (str): + The name text. For example, "5th Avenue" for + a street name or "1253" for a street number. + language_code (str): + The BCP-47 language code. This will not be + present if the component name is not associated + with a language, such as a street number. + """ + + text: str = proto.Field( + proto.STRING, + number=1, + ) + language_code: str = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py new file mode 100644 index 000000000000..fa17505ce88d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py @@ -0,0 +1,413 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.maps.addressvalidation_v1.types import address as gma_address +from google.maps.addressvalidation_v1.types import geocode as gma_geocode +from google.maps.addressvalidation_v1.types import metadata_ +from google.maps.addressvalidation_v1.types import usps_data as gma_usps_data +from google.type import postal_address_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.maps.addressvalidation.v1', + manifest={ + 'ValidateAddressRequest', + 'ValidateAddressResponse', + 'ProvideValidationFeedbackRequest', + 'ProvideValidationFeedbackResponse', + 'ValidationResult', + 'Verdict', + }, +) + + +class ValidateAddressRequest(proto.Message): + r"""The request for validating an address. + + Attributes: + address (google.type.postal_address_pb2.PostalAddress): + Required. The address being validated. Unformatted addresses + should be submitted via + [``address_lines``][google.type.PostalAddress.address_lines]. + + The total length of the fields in this input must not exceed + 280 characters. + + Supported regions can be found + `here `__. + + The [language_code][google.type.PostalAddress.language_code] + value in the input address is reserved for future uses and + is ignored today. The validated address result will be + populated based on the preferred language for the given + address, as identified by the system. + + The Address Validation API ignores the values in + [recipients][google.type.PostalAddress.recipients] and + [organization][google.type.PostalAddress.organization]. Any + values in those fields will be discarded and not returned. + Please do not set them. + previous_response_id (str): + This field must be empty for the first address validation + request. If more requests are necessary to fully validate a + single address (for example if the changes the user makes + after the initial validation need to be re-validated), then + each followup request must populate this field with the + [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id] + from the very first response in the validation sequence. + enable_usps_cass (bool): + Enables USPS CASS compatible mode. This affects *only* the + [google.maps.addressvalidation.v1.ValidationResult.usps_data] + field of + [google.maps.addressvalidation.v1.ValidationResult]. Note: + for USPS CASS enabled requests for addresses in Puerto Rico, + a [google.type.PostalAddress.region_code] of the ``address`` + must be provided as "PR", or an + [google.type.PostalAddress.administrative_area] of the + ``address`` must be provided as "Puerto Rico" + (case-insensitive) or "PR". + + It's recommended to use a componentized ``address``, or + alternatively specify at least two + [google.type.PostalAddress.address_lines] where the first + line contains the street number and name and the second line + contains the city, state, and zip code. + session_token (str): + Optional. A string which identifies an Autocomplete session + for billing purposes. Must be a URL and filename safe base64 + string with at most 36 ASCII characters in length. Otherwise + an INVALID_ARGUMENT error is returned. + + The session begins when the user starts typing a query, and + concludes when they select a place and a call to Place + Details or Address Validation is made. Each session can have + multiple autocomplete queries, followed by one Place Details + or Address Validation request. The credentials used for each + request within a session must belong to the same Google + Cloud Console project. Once a session has concluded, the + token is no longer valid; your app must generate a fresh + token for each session. If the ``session_token`` parameter + is omitted, or if you reuse a session token, the session is + charged as if no session token was provided (each request is + billed separately). + + Note: Address Validation can only be used in sessions with + the Autocomplete (New) API, not the old Autocomplete API. + See + https://developers.google.com/maps/documentation/places/web-service/session-pricing + for more details. + """ + + address: postal_address_pb2.PostalAddress = proto.Field( + proto.MESSAGE, + number=1, + message=postal_address_pb2.PostalAddress, + ) + previous_response_id: str = proto.Field( + proto.STRING, + number=2, + ) + enable_usps_cass: bool = proto.Field( + proto.BOOL, + number=3, + ) + session_token: str = proto.Field( + proto.STRING, + number=5, + ) + + +class ValidateAddressResponse(proto.Message): + r"""The response to an address validation request. + + Attributes: + result (google.maps.addressvalidation_v1.types.ValidationResult): + The result of the address validation. + response_id (str): + The UUID that identifies this response. If the address needs + to be re-validated, this UUID *must* accompany the new + request. + """ + + result: 'ValidationResult' = proto.Field( + proto.MESSAGE, + number=1, + message='ValidationResult', + ) + response_id: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ProvideValidationFeedbackRequest(proto.Message): + r"""The request for sending validation feedback. + + Attributes: + conclusion (google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest.ValidationConclusion): + Required. The outcome of the sequence of validation + attempts. + + If this field is set to + ``VALIDATION_CONCLUSION_UNSPECIFIED``, an + ``INVALID_ARGUMENT`` error will be returned. + response_id (str): + Required. The ID of the response that this feedback is for. + This should be the + [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] + from the first response in a series of address validation + attempts. + """ + class ValidationConclusion(proto.Enum): + r"""The possible final outcomes of the sequence of address + validation requests needed to validate an address. + + Values: + VALIDATION_CONCLUSION_UNSPECIFIED (0): + This value is unused. If the + ``ProvideValidationFeedbackRequest.conclusion`` field is set + to ``VALIDATION_CONCLUSION_UNSPECIFIED``, an + ``INVALID_ARGUMENT`` error will be returned. + VALIDATED_VERSION_USED (1): + The version of the address returned by the + Address Validation API was used for the + transaction. + USER_VERSION_USED (2): + The version of the address provided by the + user was used for the transaction + UNVALIDATED_VERSION_USED (3): + A version of the address that was entered + after the last validation attempt but that was + not re-validated was used for the transaction. + UNUSED (4): + The transaction was abandoned and the address + was not used. + """ + VALIDATION_CONCLUSION_UNSPECIFIED = 0 + VALIDATED_VERSION_USED = 1 + USER_VERSION_USED = 2 + UNVALIDATED_VERSION_USED = 3 + UNUSED = 4 + + conclusion: ValidationConclusion = proto.Field( + proto.ENUM, + number=1, + enum=ValidationConclusion, + ) + response_id: str = proto.Field( + proto.STRING, + number=2, + ) + + +class ProvideValidationFeedbackResponse(proto.Message): + r"""The response for validation feedback. + + The response is empty if the feedback is sent successfully. + + """ + + +class ValidationResult(proto.Message): + r"""The result of validating an address. + + Attributes: + verdict (google.maps.addressvalidation_v1.types.Verdict): + Overall verdict flags + address (google.maps.addressvalidation_v1.types.Address): + Information about the address itself as + opposed to the geocode. + geocode (google.maps.addressvalidation_v1.types.Geocode): + Information about the location and place that + the address geocoded to. + metadata (google.maps.addressvalidation_v1.types.AddressMetadata): + Other information relevant to deliverability. ``metadata`` + is not guaranteed to be fully populated for every address + sent to the Address Validation API. + usps_data (google.maps.addressvalidation_v1.types.UspsData): + Extra deliverability flags provided by USPS. Only provided + in region ``US`` and ``PR``. + """ + + verdict: 'Verdict' = proto.Field( + proto.MESSAGE, + number=1, + message='Verdict', + ) + address: gma_address.Address = proto.Field( + proto.MESSAGE, + number=2, + message=gma_address.Address, + ) + geocode: gma_geocode.Geocode = proto.Field( + proto.MESSAGE, + number=3, + message=gma_geocode.Geocode, + ) + metadata: metadata_.AddressMetadata = proto.Field( + proto.MESSAGE, + number=4, + message=metadata_.AddressMetadata, + ) + usps_data: gma_usps_data.UspsData = proto.Field( + proto.MESSAGE, + number=5, + message=gma_usps_data.UspsData, + ) + + +class Verdict(proto.Message): + r"""High level overview of the address validation result and + geocode. + + Attributes: + input_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): + The granularity of the **input** address. This is the result + of parsing the input address and does not give any + validation signals. For validation signals, refer to + ``validation_granularity`` below. + + For example, if the input address includes a specific + apartment number, then the ``input_granularity`` here will + be ``SUB_PREMISE``. If we cannot match the apartment number + in the databases or the apartment number is invalid, the + ``validation_granularity`` will likely be ``PREMISE`` or + below. + validation_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): + The granularity level that the API can fully **validate** + the address to. For example, an ``validation_granularity`` + of ``PREMISE`` indicates all address components at the level + of ``PREMISE`` or more coarse can be validated. + + Per address component validation result can be found in + [google.maps.addressvalidation.v1.Address.address_components]. + geocode_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): + Information about the granularity of the + [``geocode``][google.maps.addressvalidation.v1.ValidationResult.geocode]. + This can be understood as the semantic meaning of how coarse + or fine the geocoded location is. + + This can differ from the ``validation_granularity`` above + occasionally. For example, our database might record the + existence of an apartment number but do not have a precise + location for the apartment within a big apartment complex. + In that case, the ``validation_granularity`` will be + ``SUB_PREMISE`` but the ``geocode_granularity`` will be + ``PREMISE``. + address_complete (bool): + The address is considered complete if there are no + unresolved tokens, no unexpected or missing address + components. See + [``missing_component_types``][google.maps.addressvalidation.v1.Address.missing_component_types], + [``unresolved_tokens``][google.maps.addressvalidation.v1.Address.unresolved_tokens] + or + [``unexpected``][google.maps.addressvalidation.v1.AddressComponent.unexpected] + fields for more details. + has_unconfirmed_components (bool): + At least one address component cannot be categorized or + validated, see + [google.maps.addressvalidation.v1.Address.address_components] + for details. + has_inferred_components (bool): + At least one address component was inferred (added) that + wasn't in the input, see + [google.maps.addressvalidation.v1.Address.address_components] + for details. + has_replaced_components (bool): + At least one address component was replaced, see + [google.maps.addressvalidation.v1.Address.address_components] + for details. + """ + class Granularity(proto.Enum): + r"""The various granularities that an address or a geocode can have. + When used to indicate granularity for an *address*, these values + indicate with how fine a granularity the address identifies a + mailing destination. For example, an address such as "123 Main + Street, Redwood City, CA, 94061" identifies a ``PREMISE`` while + something like "Redwood City, CA, 94061" identifies a ``LOCALITY``. + However, if we are unable to find a geocode for "123 Main Street" in + Redwood City, the geocode returned might be of ``LOCALITY`` + granularity even though the address is more granular. + + Values: + GRANULARITY_UNSPECIFIED (0): + Default value. This value is unused. + SUB_PREMISE (1): + Below-building level result, such as an + apartment. + PREMISE (2): + Building-level result. + PREMISE_PROXIMITY (3): + A geocode that approximates the + building-level location of the address. + BLOCK (4): + The address or geocode indicates a block. + Only used in regions which have block-level + addressing, such as Japan. + ROUTE (5): + The geocode or address is granular to route, + such as a street, road, or highway. + OTHER (6): + All other granularities, which are bucketed + together since they are not deliverable. + """ + GRANULARITY_UNSPECIFIED = 0 + SUB_PREMISE = 1 + PREMISE = 2 + PREMISE_PROXIMITY = 3 + BLOCK = 4 + ROUTE = 5 + OTHER = 6 + + input_granularity: Granularity = proto.Field( + proto.ENUM, + number=1, + enum=Granularity, + ) + validation_granularity: Granularity = proto.Field( + proto.ENUM, + number=2, + enum=Granularity, + ) + geocode_granularity: Granularity = proto.Field( + proto.ENUM, + number=3, + enum=Granularity, + ) + address_complete: bool = proto.Field( + proto.BOOL, + number=4, + ) + has_unconfirmed_components: bool = proto.Field( + proto.BOOL, + number=5, + ) + has_inferred_components: bool = proto.Field( + proto.BOOL, + number=6, + ) + has_replaced_components: bool = proto.Field( + proto.BOOL, + number=7, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py new file mode 100644 index 000000000000..10af4ddb590e --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +from google.geo.type.types import viewport +from google.type import latlng_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.maps.addressvalidation.v1', + manifest={ + 'Geocode', + 'PlusCode', + }, +) + + +class Geocode(proto.Message): + r"""Contains information about the place the input was geocoded + to. + + Attributes: + location (google.type.latlng_pb2.LatLng): + The geocoded location of the input. + + Using place IDs is preferred over using + addresses, latitude/longitude coordinates, or + plus codes. Using coordinates when routing or + calculating driving directions will always + result in the point being snapped to the road + nearest to those coordinates. This may not be a + road that will quickly or safely lead to the + destination and may not be near an access point + to the property. Additionally, when a location + is reverse geocoded, there is no guarantee that + the returned address will match the original. + plus_code (google.maps.addressvalidation_v1.types.PlusCode): + The plus code corresponding to the ``location``. + bounds (google.geo.type.types.Viewport): + The bounds of the geocoded place. + feature_size_meters (float): + The size of the geocoded place, in meters. + This is another measure of the coarseness of the + geocoded location, but in physical size rather + than in semantic meaning. + place_id (str): + The PlaceID of the place this input geocodes to. + + For more information about Place IDs see + `here `__. + place_types (MutableSequence[str]): + The type(s) of place that the input geocoded to. For + example, ``['locality', 'political']``. The full list of + types can be found + `here `__. + """ + + location: latlng_pb2.LatLng = proto.Field( + proto.MESSAGE, + number=1, + message=latlng_pb2.LatLng, + ) + plus_code: 'PlusCode' = proto.Field( + proto.MESSAGE, + number=2, + message='PlusCode', + ) + bounds: viewport.Viewport = proto.Field( + proto.MESSAGE, + number=4, + message=viewport.Viewport, + ) + feature_size_meters: float = proto.Field( + proto.FLOAT, + number=5, + ) + place_id: str = proto.Field( + proto.STRING, + number=6, + ) + place_types: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=7, + ) + + +class PlusCode(proto.Message): + r"""Plus code (http://plus.codes) is a location reference with + two formats: global code defining a 14mx14m (1/8000th of a + degree) or smaller rectangle, and compound code, replacing the + prefix with a reference location. + + Attributes: + global_code (str): + Place's global (full) code, such as + "9FWM33GV+HQ", representing an 1/8000 by 1/8000 + degree area (~14 by 14 meters). + compound_code (str): + Place's compound code, such as "33GV+HQ, + Ramberg, Norway", containing the suffix of the + global code and replacing the prefix with a + formatted name of a reference entity. + """ + + global_code: str = proto.Field( + proto.STRING, + number=1, + ) + compound_code: str = proto.Field( + proto.STRING, + number=2, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py new file mode 100644 index 000000000000..08e6d46d4509 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.maps.addressvalidation.v1', + manifest={ + 'AddressMetadata', + }, +) + + +class AddressMetadata(proto.Message): + r"""The metadata for the address. ``metadata`` is not guaranteed to be + fully populated for every address sent to the Address Validation + API. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + business (bool): + Indicates that this is the address of a + business. If unset, indicates that the value is + unknown. + + This field is a member of `oneof`_ ``_business``. + po_box (bool): + Indicates that the address of a PO box. + If unset, indicates that the value is unknown. + + This field is a member of `oneof`_ ``_po_box``. + residential (bool): + Indicates that this is the address of a + residence. If unset, indicates that the value is + unknown. + + This field is a member of `oneof`_ ``_residential``. + """ + + business: bool = proto.Field( + proto.BOOL, + number=2, + optional=True, + ) + po_box: bool = proto.Field( + proto.BOOL, + number=3, + optional=True, + ) + residential: bool = proto.Field( + proto.BOOL, + number=6, + optional=True, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py new file mode 100644 index 000000000000..af81676ea2aa --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py @@ -0,0 +1,493 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.maps.addressvalidation.v1', + manifest={ + 'UspsAddress', + 'UspsData', + }, +) + + +class UspsAddress(proto.Message): + r"""USPS representation of a US address. + + Attributes: + first_address_line (str): + First address line. + firm (str): + Firm name. + second_address_line (str): + Second address line. + urbanization (str): + Puerto Rican urbanization name. + city_state_zip_address_line (str): + City + state + postal code. + city (str): + City name. + state (str): + 2 letter state code. + zip_code (str): + Postal code e.g. 10009. + zip_code_extension (str): + 4-digit postal code extension e.g. 5023. + """ + + first_address_line: str = proto.Field( + proto.STRING, + number=1, + ) + firm: str = proto.Field( + proto.STRING, + number=2, + ) + second_address_line: str = proto.Field( + proto.STRING, + number=3, + ) + urbanization: str = proto.Field( + proto.STRING, + number=4, + ) + city_state_zip_address_line: str = proto.Field( + proto.STRING, + number=5, + ) + city: str = proto.Field( + proto.STRING, + number=6, + ) + state: str = proto.Field( + proto.STRING, + number=7, + ) + zip_code: str = proto.Field( + proto.STRING, + number=8, + ) + zip_code_extension: str = proto.Field( + proto.STRING, + number=9, + ) + + +class UspsData(proto.Message): + r"""The USPS data for the address. ``uspsData`` is not guaranteed to be + fully populated for every US or PR address sent to the Address + Validation API. It's recommended to integrate the backup address + fields in the response if you utilize uspsData as the primary part + of the response. + + Attributes: + standardized_address (google.maps.addressvalidation_v1.types.UspsAddress): + USPS standardized address. + delivery_point_code (str): + 2 digit delivery point code + delivery_point_check_digit (str): + The delivery point check digit. This number is added to the + end of the delivery_point_barcode for mechanically scanned + mail. Adding all the digits of the delivery_point_barcode, + delivery_point_check_digit, postal code, and ZIP+4 together + should yield a number divisible by 10. + dpv_confirmation (str): + The possible values for DPV confirmation. Returns a single + character or returns no value. + + - ``N``: Primary and any secondary number information + failed to DPV confirm. + - ``D``: Address was DPV confirmed for the primary number + only, and the secondary number information was missing. + - ``S``: Address was DPV confirmed for the primary number + only, and the secondary number information was present + but not confirmed. + - ``Y``: Address was DPV confirmed for primary and any + secondary numbers. + - Empty: If the response does not contain a + ``dpv_confirmation`` value, the address was not submitted + for DPV confirmation. + dpv_footnote (str): + The footnotes from delivery point validation. Multiple + footnotes may be strung together in the same string. + + - ``AA``: Input address matched to the ZIP+4 file + - ``A1``: Input address was not matched to the ZIP+4 file + - ``BB``: Matched to DPV (all components) + - ``CC``: Secondary number not matched and not required + - ``C1``: Secondary number not matched but required + - ``N1``: High-rise address missing secondary number + - ``M1``: Primary number missing + - ``M3``: Primary number invalid + - ``P1``: Input address PO, RR or HC box number missing + - ``P3``: Input address PO, RR, or HC Box number invalid + - ``F1``: Input address matched to a military address + - ``G1``: Input address matched to a general delivery + address + - ``U1``: Input address matched to a unique ZIP code + - ``PB``: Input address matched to PBSA record + - ``RR``: DPV confirmed address with PMB information + - ``R1``: DPV confirmed address without PMB information + - ``R7``: Carrier Route R777 or R779 record + - ``IA``: Informed Address identified + - ``TA``: Primary number matched by dropping a trailing + alpha + dpv_cmra (str): + Indicates if the address is a CMRA (Commercial Mail + Receiving Agency)--a private business receiving mail for + clients. Returns a single character. + + - ``Y``: The address is a CMRA + - ``N``: The address is not a CMRA + dpv_vacant (str): + Is this place vacant? Returns a single character. + + - ``Y``: The address is vacant + - ``N``: The address is not vacant + dpv_no_stat (str): + Is this a no stat address or an active address? No stat + addresses are ones which are not continuously occupied or + addresses that the USPS does not service. Returns a single + character. + + - ``Y``: The address is not active + - ``N``: The address is active + dpv_no_stat_reason_code (int): + Indicates the NoStat type. Returns a reason code as int. + + - ``1``: IDA (Internal Drop Address) – Addresses that do + not receive mail directly from the USPS but are delivered + to a drop address that services them. + - ``2``: CDS - Addresses that have not yet become + deliverable. For example, a new subdivision where lots + and primary numbers have been determined, but no + structure exists yet for occupancy. + - ``3``: Collision - Addresses that do not actually DPV + confirm. + - ``4``: CMZ (College, Military and Other Types) - ZIP + 4 + records USPS has incorporated into the data. + - ``5``: Regular - Indicates addresses not receiving + delivery and the addresses are not counted as possible + deliveries. + - ``6``: Secondary Required - The address requires + secondary information. + dpv_drop (str): + Flag indicates mail is delivered to a single receptable at a + site. Returns a single character. + + - ``Y``: The mail is delivered to a single receptable at a + site. + - ``N``: The mail is not delivered to a single receptable + at a site. + dpv_throwback (str): + Indicates that mail is not delivered to the street address. + Returns a single character. + + - ``Y``: The mail is not delivered to the street address. + - ``N``: The mail is delivered to the street address. + dpv_non_delivery_days (str): + Flag indicates mail delivery is not performed every day of + the week. Returns a single character. + + - ``Y``: The mail delivery is not performed every day of + the week. + - ``N``: No indication the mail delivery is not performed + every day of the week. + dpv_non_delivery_days_values (int): + Integer identifying non-delivery days. It can + be interrogated using bit flags: + + 0x40 – Sunday is a non-delivery day + 0x20 – Monday is a non-delivery day + 0x10 – Tuesday is a non-delivery day + 0x08 – Wednesday is a non-delivery day + 0x04 – Thursday is a non-delivery day + 0x02 – Friday is a non-delivery day + 0x01 – Saturday is a non-delivery day + dpv_no_secure_location (str): + Flag indicates door is accessible, but package will not be + left due to security concerns. Returns a single character. + + - ``Y``: The package will not be left due to security + concerns. + - ``N``: No indication the package will not be left due to + security concerns. + dpv_pbsa (str): + Indicates the address was matched to PBSA record. Returns a + single character. + + - ``Y``: The address was matched to PBSA record. + - ``N``: The address was not matched to PBSA record. + dpv_door_not_accessible (str): + Flag indicates addresses where USPS cannot knock on a door + to deliver mail. Returns a single character. + + - ``Y``: The door is not accessible. + - ``N``: No indication the door is not accessible. + dpv_enhanced_delivery_code (str): + Indicates that more than one DPV return code is valid for + the address. Returns a single character. + + - ``Y``: Address was DPV confirmed for primary and any + secondary numbers. + - ``N``: Primary and any secondary number information + failed to DPV confirm. + - ``S``: Address was DPV confirmed for the primary number + only, and the secondary number information was present by + not confirmed, or a single trailing alpha on a primary + number was dropped to make a DPV match and secondary + information required. + - ``D``: Address was DPV confirmed for the primary number + only, and the secondary number information was missing. + - ``R``: Address confirmed but assigned to phantom route + R777 and R779 and USPS delivery is not provided. + carrier_route (str): + The carrier route code. A four character code consisting of + a one letter prefix and a three digit route designator. + + Prefixes: + + - ``C``: Carrier route (or city route) + - ``R``: Rural route + - ``H``: Highway Contract Route + - ``B``: Post Office Box Section + - ``G``: General delivery unit + carrier_route_indicator (str): + Carrier route rate sort indicator. + ews_no_match (bool): + The delivery address is matchable, but the + EWS file indicates that an exact match will be + available soon. + post_office_city (str): + Main post office city. + post_office_state (str): + Main post office state. + abbreviated_city (str): + Abbreviated city. + fips_county_code (str): + FIPS county code. + county (str): + County name. + elot_number (str): + Enhanced Line of Travel (eLOT) number. + elot_flag (str): + eLOT Ascending/Descending Flag (A/D). + lacs_link_return_code (str): + LACSLink return code. + lacs_link_indicator (str): + LACSLink indicator. + po_box_only_postal_code (bool): + PO Box only postal code. + suitelink_footnote (str): + Footnotes from matching a street or highrise record to suite + information. If business name match is found, the secondary + number is returned. + + - ``A``: SuiteLink record match, business address improved. + - ``00``: No match, business address is not improved. + pmb_designator (str): + PMB (Private Mail Box) unit designator. + pmb_number (str): + PMB (Private Mail Box) number; + address_record_type (str): + Type of the address record that matches the input address. + + - ``F``: FIRM. This is a match to a Firm Record, which is + the finest level of match available for an address. + - ``G``: GENERAL DELIVERY. This is a match to a General + Delivery record. + - ``H``: BUILDING / APARTMENT. This is a match to a + Building or Apartment record. + - ``P``: POST OFFICE BOX. This is a match to a Post Office + Box. + - ``R``: RURAL ROUTE or HIGHWAY CONTRACT: This is a match + to either a Rural Route or a Highway Contract record, + both of which may have associated Box Number ranges. + - ``S``: STREET RECORD: This is a match to a Street record + containing a valid primary number range. + default_address (bool): + Indicator that a default address was found, + but more specific addresses exists. + error_message (str): + Error message for USPS data retrieval. This + is populated when USPS processing is suspended + because of the detection of artificially created + addresses. + + The USPS data fields might not be populated when + this error is present. + cass_processed (bool): + Indicator that the request has been CASS + processed. + """ + + standardized_address: 'UspsAddress' = proto.Field( + proto.MESSAGE, + number=1, + message='UspsAddress', + ) + delivery_point_code: str = proto.Field( + proto.STRING, + number=2, + ) + delivery_point_check_digit: str = proto.Field( + proto.STRING, + number=3, + ) + dpv_confirmation: str = proto.Field( + proto.STRING, + number=4, + ) + dpv_footnote: str = proto.Field( + proto.STRING, + number=5, + ) + dpv_cmra: str = proto.Field( + proto.STRING, + number=6, + ) + dpv_vacant: str = proto.Field( + proto.STRING, + number=7, + ) + dpv_no_stat: str = proto.Field( + proto.STRING, + number=8, + ) + dpv_no_stat_reason_code: int = proto.Field( + proto.INT32, + number=29, + ) + dpv_drop: str = proto.Field( + proto.STRING, + number=30, + ) + dpv_throwback: str = proto.Field( + proto.STRING, + number=31, + ) + dpv_non_delivery_days: str = proto.Field( + proto.STRING, + number=32, + ) + dpv_non_delivery_days_values: int = proto.Field( + proto.INT32, + number=33, + ) + dpv_no_secure_location: str = proto.Field( + proto.STRING, + number=34, + ) + dpv_pbsa: str = proto.Field( + proto.STRING, + number=35, + ) + dpv_door_not_accessible: str = proto.Field( + proto.STRING, + number=36, + ) + dpv_enhanced_delivery_code: str = proto.Field( + proto.STRING, + number=37, + ) + carrier_route: str = proto.Field( + proto.STRING, + number=9, + ) + carrier_route_indicator: str = proto.Field( + proto.STRING, + number=10, + ) + ews_no_match: bool = proto.Field( + proto.BOOL, + number=11, + ) + post_office_city: str = proto.Field( + proto.STRING, + number=12, + ) + post_office_state: str = proto.Field( + proto.STRING, + number=13, + ) + abbreviated_city: str = proto.Field( + proto.STRING, + number=14, + ) + fips_county_code: str = proto.Field( + proto.STRING, + number=15, + ) + county: str = proto.Field( + proto.STRING, + number=16, + ) + elot_number: str = proto.Field( + proto.STRING, + number=17, + ) + elot_flag: str = proto.Field( + proto.STRING, + number=18, + ) + lacs_link_return_code: str = proto.Field( + proto.STRING, + number=19, + ) + lacs_link_indicator: str = proto.Field( + proto.STRING, + number=20, + ) + po_box_only_postal_code: bool = proto.Field( + proto.BOOL, + number=21, + ) + suitelink_footnote: str = proto.Field( + proto.STRING, + number=22, + ) + pmb_designator: str = proto.Field( + proto.STRING, + number=23, + ) + pmb_number: str = proto.Field( + proto.STRING, + number=24, + ) + address_record_type: str = proto.Field( + proto.STRING, + number=25, + ) + default_address: bool = proto.Field( + proto.BOOL, + number=26, + ) + error_message: str = proto.Field( + proto.STRING, + number=27, + ) + cass_processed: bool = proto.Field( + proto.BOOL, + number=28, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini b/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py b/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py new file mode 100644 index 000000000000..43670ad6bbba --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py @@ -0,0 +1,253 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +import pathlib +import re +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", + "3.12" +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = 'google-maps-addressvalidation' + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.12" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "prerelease_deps", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/maps/addressvalidation_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + +@nox.session(python=ALL_PYTHON[-1]) +def prerelease_deps(session): + """Run the unit test suite against pre-release versions of dependencies.""" + + # Install test environment dependencies + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + + # Install the package without dependencies + session.install('-e', '.', '--no-deps') + + # We test the minimum dependency versions using the minimum Python + # version so the lowest python runtime that we test has a corresponding constraints + # file, located at `testing/constraints--.txt`, which contains all of the + # dependencies and extras. + with open( + CURRENT_DIRECTORY + / "testing" + / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + session.install(*constraints_deps) + + prerel_deps = [ + "googleapis-common-protos", + "google-api-core", + "google-auth", + "grpcio", + "grpcio-status", + "protobuf", + "proto-plus", + ] + + for dep in prerel_deps: + session.install("--pre", "--no-deps", "--upgrade", dep) + + # Remaining dependencies + other_deps = [ + "requests", + ] + session.install(*other_deps) + + # Print out prerelease package versions + + session.run("python", "-c", "import google.api_core; print(google.api_core.__version__)") + session.run("python", "-c", "import google.auth; print(google.auth.__version__)") + session.run("python", "-c", "import grpc; print(grpc.__version__)") + session.run( + "python", "-c", "import google.protobuf; print(google.protobuf.__version__)" + ) + session.run( + "python", "-c", "import proto; print(proto.__version__)" + ) + + session.run( + 'py.test', + '--quiet', + '--cov=google/maps/addressvalidation_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + session.install('.') + session.run( + 'mypy', + '-p', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==7.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py new file mode 100644 index 000000000000..7274018b4b0b --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ProvideValidationFeedback +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-maps-addressvalidation + + +# [START addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.maps import addressvalidation_v1 + + +async def sample_provide_validation_feedback(): + # Create a client + client = addressvalidation_v1.AddressValidationAsyncClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ProvideValidationFeedbackRequest( + conclusion="UNUSED", + response_id="response_id_value", + ) + + # Make the request + response = await client.provide_validation_feedback(request=request) + + # Handle the response + print(response) + +# [END addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py new file mode 100644 index 000000000000..c304e0e7b77e --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ProvideValidationFeedback +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-maps-addressvalidation + + +# [START addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.maps import addressvalidation_v1 + + +def sample_provide_validation_feedback(): + # Create a client + client = addressvalidation_v1.AddressValidationClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ProvideValidationFeedbackRequest( + conclusion="UNUSED", + response_id="response_id_value", + ) + + # Make the request + response = client.provide_validation_feedback(request=request) + + # Handle the response + print(response) + +# [END addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py new file mode 100644 index 000000000000..c256fc8b091f --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ValidateAddress +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-maps-addressvalidation + + +# [START addressvalidation_v1_generated_AddressValidation_ValidateAddress_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.maps import addressvalidation_v1 + + +async def sample_validate_address(): + # Create a client + client = addressvalidation_v1.AddressValidationAsyncClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ValidateAddressRequest( + ) + + # Make the request + response = await client.validate_address(request=request) + + # Handle the response + print(response) + +# [END addressvalidation_v1_generated_AddressValidation_ValidateAddress_async] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py new file mode 100644 index 000000000000..38316149c05d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ValidateAddress +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-maps-addressvalidation + + +# [START addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.maps import addressvalidation_v1 + + +def sample_validate_address(): + # Create a client + client = addressvalidation_v1.AddressValidationClient() + + # Initialize request argument(s) + request = addressvalidation_v1.ValidateAddressRequest( + ) + + # Make the request + response = client.validate_address(request=request) + + # Handle the response + print(response) + +# [END addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json new file mode 100644 index 000000000000..b8aeda3afd23 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json @@ -0,0 +1,321 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.maps.addressvalidation.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-maps-addressvalidation", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient", + "shortName": "AddressValidationAsyncClient" + }, + "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient.provide_validation_feedback", + "method": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback", + "service": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation", + "shortName": "AddressValidation" + }, + "shortName": "ProvideValidationFeedback" + }, + "parameters": [ + { + "name": "request", + "type": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse", + "shortName": "provide_validation_feedback" + }, + "description": "Sample for ProvideValidationFeedback", + "file": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.maps.addressvalidation_v1.AddressValidationClient", + "shortName": "AddressValidationClient" + }, + "fullName": "google.maps.addressvalidation_v1.AddressValidationClient.provide_validation_feedback", + "method": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback", + "service": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation", + "shortName": "AddressValidation" + }, + "shortName": "ProvideValidationFeedback" + }, + "parameters": [ + { + "name": "request", + "type": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse", + "shortName": "provide_validation_feedback" + }, + "description": "Sample for ProvideValidationFeedback", + "file": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient", + "shortName": "AddressValidationAsyncClient" + }, + "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient.validate_address", + "method": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress", + "service": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation", + "shortName": "AddressValidation" + }, + "shortName": "ValidateAddress" + }, + "parameters": [ + { + "name": "request", + "type": "google.maps.addressvalidation_v1.types.ValidateAddressRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.maps.addressvalidation_v1.types.ValidateAddressResponse", + "shortName": "validate_address" + }, + "description": "Sample for ValidateAddress", + "file": "addressvalidation_v1_generated_address_validation_validate_address_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "addressvalidation_v1_generated_AddressValidation_ValidateAddress_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "addressvalidation_v1_generated_address_validation_validate_address_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.maps.addressvalidation_v1.AddressValidationClient", + "shortName": "AddressValidationClient" + }, + "fullName": "google.maps.addressvalidation_v1.AddressValidationClient.validate_address", + "method": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress", + "service": { + "fullName": "google.maps.addressvalidation.v1.AddressValidation", + "shortName": "AddressValidation" + }, + "shortName": "ValidateAddress" + }, + "parameters": [ + { + "name": "request", + "type": "google.maps.addressvalidation_v1.types.ValidateAddressRequest" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.maps.addressvalidation_v1.types.ValidateAddressResponse", + "shortName": "validate_address" + }, + "description": "Sample for ValidateAddress", + "file": "addressvalidation_v1_generated_address_validation_validate_address_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "addressvalidation_v1_generated_address_validation_validate_address_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py b/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py new file mode 100644 index 000000000000..07ecb8b60bc3 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py @@ -0,0 +1,177 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class addressvalidationCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'provide_validation_feedback': ('conclusion', 'response_id', ), + 'validate_address': ('address', 'previous_response_id', 'enable_usps_cass', 'session_token', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=addressvalidationCallTransformer(), +): + """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 addressvalidation client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/setup.py b/owl-bot-staging/google-maps-addressvalidation/v1/setup.py new file mode 100644 index 000000000000..474386e7f2d3 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/setup.py @@ -0,0 +1,92 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import io +import os +import re + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-maps-addressvalidation' + + +description = "Google Maps Addressvalidation API client library" + +version = None + +with open(os.path.join(package_root, 'google/maps/addressvalidation/gapic_version.py')) as fp: + version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) + assert (len(version_candidates) == 1) + version = version_candidates[0] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "google-auth >= 2.14.1, <3.0.0dev", + "proto-plus >= 1.22.3, <2.0.0dev", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", + "google-geo-type >= 0.1.0, <1.0.0dev", +] +url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-addressvalidation" + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, "README.rst") +with io.open(readme_filename, encoding="utf-8") as readme_file: + readme = readme_file.read() + +packages = [ + package + for package in setuptools.find_namespace_packages() + if package.startswith("google") +] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt new file mode 100644 index 000000000000..2214a366a259 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt new file mode 100644 index 000000000000..2214a366a259 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt new file mode 100644 index 000000000000..2214a366a259 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt new file mode 100644 index 000000000000..66fa4554264e --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt @@ -0,0 +1,11 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.1 +google-auth==2.14.1 +proto-plus==1.22.3 +protobuf==3.19.5 +google-geo-type==0.1.0 diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt new file mode 100644 index 000000000000..2214a366a259 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt new file mode 100644 index 000000000000..2214a366a259 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt @@ -0,0 +1,7 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf +google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py new file mode 100644 index 000000000000..1b4db446eb8d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py new file mode 100644 index 000000000000..1b4db446eb8d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..1b4db446eb8d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py new file mode 100644 index 000000000000..1b4db446eb8d --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py new file mode 100644 index 000000000000..abf323af2222 --- /dev/null +++ b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py @@ -0,0 +1,1944 @@ +# -*- coding: utf-8 -*- +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +import os +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from google.api_core import api_core_version +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.maps.addressvalidation_v1.services.address_validation import AddressValidationAsyncClient +from google.maps.addressvalidation_v1.services.address_validation import AddressValidationClient +from google.maps.addressvalidation_v1.services.address_validation import transports +from google.maps.addressvalidation_v1.types import address_validation_service +from google.oauth2 import service_account +from google.type import postal_address_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert AddressValidationClient._get_default_mtls_endpoint(None) is None + assert AddressValidationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert AddressValidationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert AddressValidationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert AddressValidationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert AddressValidationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + +def test__read_environment_variables(): + assert AddressValidationClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert AddressValidationClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert AddressValidationClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + AddressValidationClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert AddressValidationClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert AddressValidationClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert AddressValidationClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + AddressValidationClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert AddressValidationClient._read_environment_variables() == (False, "auto", "foo.com") + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert AddressValidationClient._get_client_cert_source(None, False) is None + assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, False) is None + assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): + assert AddressValidationClient._get_client_cert_source(None, True) is mock_default_cert_source + assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source + +@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) +@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = AddressValidationClient._DEFAULT_UNIVERSE + default_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + assert AddressValidationClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override + assert AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT + assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint + assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "always") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT + assert AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT + assert AddressValidationClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint + assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + + with pytest.raises(MutualTLSChannelError) as excinfo: + AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") + assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert AddressValidationClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain + assert AddressValidationClient._get_universe_domain(None, universe_domain_env) == universe_domain_env + assert AddressValidationClient._get_universe_domain(None, None) == AddressValidationClient._DEFAULT_UNIVERSE + + with pytest.raises(ValueError) as excinfo: + AddressValidationClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), +]) +def test__validate_universe_domain(client_class, transport_class, transport_name): + client = client_class( + transport=transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + ) + assert client._validate_universe_domain() == True + + # Test the case when universe is already validated. + assert client._validate_universe_domain() == True + + if transport_name == "grpc": + # Test the case where credentials are provided by the + # `local_channel_credentials`. The default universes in both match. + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + client = client_class(transport=transport_class(channel=channel)) + assert client._validate_universe_domain() == True + + # Test the case where credentials do not exist: e.g. a transport is provided + # with no credentials. Validation should still succeed because there is no + # mismatch with non-existent credentials. + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + transport=transport_class(channel=channel) + transport._credentials = None + client = client_class(transport=transport) + assert client._validate_universe_domain() == True + + # TODO: This is needed to cater for older versions of google-auth + # Make this test unconditional once the minimum supported version of + # google-auth becomes 2.23.0 or higher. + google_auth_major, google_auth_minor = [int(part) for part in google.auth.__version__.split(".")[0:2]] + if google_auth_major > 2 or (google_auth_major == 2 and google_auth_minor >= 23): + credentials = ga_credentials.AnonymousCredentials() + credentials._universe_domain = "foo.com" + # Test the case when there is a universe mismatch from the credentials. + client = client_class( + transport=transport_class(credentials=credentials) + ) + with pytest.raises(ValueError) as excinfo: + client._validate_universe_domain() + assert str(excinfo.value) == "The configured universe domain (googleapis.com) does not match the universe domain found in the credentials (foo.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." + + # Test the case when there is a universe mismatch from the client. + # + # TODO: Make this test unconditional once the minimum supported version of + # google-api-core becomes 2.15.0 or higher. + api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]] + if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 15): + client = client_class(client_options={"universe_domain": "bar.com"}, transport=transport_class(credentials=ga_credentials.AnonymousCredentials(),)) + with pytest.raises(ValueError) as excinfo: + client._validate_universe_domain() + assert str(excinfo.value) == "The configured universe domain (bar.com) does not match the universe domain found in the credentials (googleapis.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." + + # Test that ValueError is raised if universe_domain is provided via client options and credentials is None + with pytest.raises(ValueError): + client._compare_universes("foo.bar", None) + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AddressValidationClient, "grpc"), + (AddressValidationAsyncClient, "grpc_asyncio"), + (AddressValidationClient, "rest"), +]) +def test_address_validation_client_from_service_account_info(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'addressvalidation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://addressvalidation.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.AddressValidationGrpcTransport, "grpc"), + (transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.AddressValidationRestTransport, "rest"), +]) +def test_address_validation_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class,transport_name", [ + (AddressValidationClient, "grpc"), + (AddressValidationAsyncClient, "grpc_asyncio"), + (AddressValidationClient, "rest"), +]) +def test_address_validation_client_from_service_account_file(client_class, transport_name): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'addressvalidation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://addressvalidation.googleapis.com' + ) + + +def test_address_validation_client_get_transport_class(): + transport = AddressValidationClient.get_transport_class() + available_transports = [ + transports.AddressValidationGrpcTransport, + transports.AddressValidationRestTransport, + ] + assert transport in available_transports + + transport = AddressValidationClient.get_transport_class("grpc") + assert transport == transports.AddressValidationGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), +]) +@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) +@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) +def test_address_validation_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(AddressValidationClient, '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(AddressValidationClient, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", "true"), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", "false"), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest", "true"), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest", "false"), +]) +@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) +@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_address_validation_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class", [ + AddressValidationClient, AddressValidationAsyncClient +]) +@mock.patch.object(AddressValidationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AddressValidationClient)) +@mock.patch.object(AddressValidationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AddressValidationAsyncClient)) +def test_address_validation_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + +@pytest.mark.parametrize("client_class", [ + AddressValidationClient, AddressValidationAsyncClient +]) +@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) +@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) +def test_address_validation_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = AddressValidationClient._DEFAULT_UNIVERSE + default_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + else: + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) + assert client.universe_domain == (mock_universe if universe_exists else default_universe) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), +]) +def test_address_validation_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", grpc_helpers), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (AddressValidationClient, transports.AddressValidationRestTransport, "rest", None), +]) +def test_address_validation_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + +def test_address_validation_client_client_options_from_dict(): + with mock.patch('google.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = AddressValidationClient( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", grpc_helpers), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_address_validation_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "addressvalidation.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( +), + scopes=None, + default_host="addressvalidation.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + address_validation_service.ValidateAddressRequest, + dict, +]) +def test_validate_address(request_type, transport: str = 'grpc'): + client = AddressValidationClient( + 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.validate_address), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = address_validation_service.ValidateAddressResponse( + response_id='response_id_value', + ) + response = client.validate_address(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ValidateAddressRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ValidateAddressResponse) + assert response.response_id == 'response_id_value' + + +def test_validate_address_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 = AddressValidationClient( + 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.validate_address), + '__call__') as call: + client.validate_address() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ValidateAddressRequest() + +@pytest.mark.asyncio +async def test_validate_address_async(transport: str = 'grpc_asyncio', request_type=address_validation_service.ValidateAddressRequest): + client = AddressValidationAsyncClient( + 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.validate_address), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(address_validation_service.ValidateAddressResponse( + response_id='response_id_value', + )) + response = await client.validate_address(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ValidateAddressRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ValidateAddressResponse) + assert response.response_id == 'response_id_value' + + +@pytest.mark.asyncio +async def test_validate_address_async_from_dict(): + await test_validate_address_async(request_type=dict) + + +@pytest.mark.parametrize("request_type", [ + address_validation_service.ProvideValidationFeedbackRequest, + dict, +]) +def test_provide_validation_feedback(request_type, transport: str = 'grpc'): + client = AddressValidationClient( + 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.provide_validation_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = address_validation_service.ProvideValidationFeedbackResponse( + ) + response = client.provide_validation_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) + + +def test_provide_validation_feedback_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 = AddressValidationClient( + 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.provide_validation_feedback), + '__call__') as call: + client.provide_validation_feedback() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() + +@pytest.mark.asyncio +async def test_provide_validation_feedback_async(transport: str = 'grpc_asyncio', request_type=address_validation_service.ProvideValidationFeedbackRequest): + client = AddressValidationAsyncClient( + 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.provide_validation_feedback), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(address_validation_service.ProvideValidationFeedbackResponse( + )) + response = await client.provide_validation_feedback(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) + + +@pytest.mark.asyncio +async def test_provide_validation_feedback_async_from_dict(): + await test_provide_validation_feedback_async(request_type=dict) + + +@pytest.mark.parametrize("request_type", [ + address_validation_service.ValidateAddressRequest, + dict, +]) +def test_validate_address_rest(request_type): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = address_validation_service.ValidateAddressResponse( + response_id='response_id_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = address_validation_service.ValidateAddressResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.validate_address(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ValidateAddressResponse) + assert response.response_id == 'response_id_value' + + +def test_validate_address_rest_required_fields(request_type=address_validation_service.ValidateAddressRequest): + transport_class = transports.AddressValidationRestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).validate_address._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).validate_address._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = address_validation_service.ValidateAddressResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = address_validation_service.ValidateAddressResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.validate_address(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_validate_address_rest_unset_required_fields(): + transport = transports.AddressValidationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.validate_address._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("address", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_validate_address_rest_interceptors(null_interceptor): + transport = transports.AddressValidationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AddressValidationRestInterceptor(), + ) + client = AddressValidationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AddressValidationRestInterceptor, "post_validate_address") as post, \ + mock.patch.object(transports.AddressValidationRestInterceptor, "pre_validate_address") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = address_validation_service.ValidateAddressRequest.pb(address_validation_service.ValidateAddressRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = address_validation_service.ValidateAddressResponse.to_json(address_validation_service.ValidateAddressResponse()) + + request = address_validation_service.ValidateAddressRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = address_validation_service.ValidateAddressResponse() + + client.validate_address(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_validate_address_rest_bad_request(transport: str = 'rest', request_type=address_validation_service.ValidateAddressRequest): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.validate_address(request) + + +def test_validate_address_rest_error(): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + address_validation_service.ProvideValidationFeedbackRequest, + dict, +]) +def test_provide_validation_feedback_rest(request_type): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = address_validation_service.ProvideValidationFeedbackResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = address_validation_service.ProvideValidationFeedbackResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.provide_validation_feedback(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) + + +def test_provide_validation_feedback_rest_required_fields(request_type=address_validation_service.ProvideValidationFeedbackRequest): + transport_class = transports.AddressValidationRestTransport + + request_init = {} + request_init["response_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).provide_validation_feedback._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["responseId"] = 'response_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).provide_validation_feedback._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "responseId" in jsonified_request + assert jsonified_request["responseId"] == 'response_id_value' + + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = address_validation_service.ProvideValidationFeedbackResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = address_validation_service.ProvideValidationFeedbackResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.provide_validation_feedback(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_provide_validation_feedback_rest_unset_required_fields(): + transport = transports.AddressValidationRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.provide_validation_feedback._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("conclusion", "responseId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_provide_validation_feedback_rest_interceptors(null_interceptor): + transport = transports.AddressValidationRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.AddressValidationRestInterceptor(), + ) + client = AddressValidationClient(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.AddressValidationRestInterceptor, "post_provide_validation_feedback") as post, \ + mock.patch.object(transports.AddressValidationRestInterceptor, "pre_provide_validation_feedback") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = address_validation_service.ProvideValidationFeedbackRequest.pb(address_validation_service.ProvideValidationFeedbackRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = address_validation_service.ProvideValidationFeedbackResponse.to_json(address_validation_service.ProvideValidationFeedbackResponse()) + + request = address_validation_service.ProvideValidationFeedbackRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = address_validation_service.ProvideValidationFeedbackResponse() + + client.provide_validation_feedback(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_provide_validation_feedback_rest_bad_request(transport: str = 'rest', request_type=address_validation_service.ProvideValidationFeedbackRequest): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.provide_validation_feedback(request) + + +def test_provide_validation_feedback_rest_error(): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AddressValidationClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AddressValidationClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AddressValidationClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AddressValidationClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AddressValidationClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AddressValidationGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AddressValidationGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.AddressValidationGrpcTransport, + transports.AddressValidationGrpcAsyncIOTransport, + transports.AddressValidationRestTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = AddressValidationClient.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AddressValidationGrpcTransport, + ) + +def test_address_validation_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AddressValidationTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_address_validation_base_transport(): + # Instantiate the base transport. + with mock.patch('google.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.AddressValidationTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'validate_address', + 'provide_validation_feedback', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_address_validation_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.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AddressValidationTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( +), + quota_project_id="octopus", + ) + + +def test_address_validation_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.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AddressValidationTransport() + adc.assert_called_once() + + +def test_address_validation_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) + AddressValidationClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AddressValidationGrpcTransport, + transports.AddressValidationGrpcAsyncIOTransport, + ], +) +def test_address_validation_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=(), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AddressValidationGrpcTransport, + transports.AddressValidationGrpcAsyncIOTransport, + transports.AddressValidationRestTransport, + ], +) +def test_address_validation_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AddressValidationGrpcTransport, grpc_helpers), + (transports.AddressValidationGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_address_validation_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( + "addressvalidation.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( +), + scopes=["1", "2"], + default_host="addressvalidation.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) +def test_address_validation_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + +def test_address_validation_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.AddressValidationRestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_address_validation_host_no_port(transport_name): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='addressvalidation.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'addressvalidation.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://addressvalidation.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_address_validation_host_with_port(transport_name): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='addressvalidation.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'addressvalidation.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://addressvalidation.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_address_validation_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = AddressValidationClient( + credentials=creds1, + transport=transport_name, + ) + client2 = AddressValidationClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.validate_address._session + session2 = client2.transport.validate_address._session + assert session1 != session2 + session1 = client1.transport.provide_validation_feedback._session + session2 = client2.transport.provide_validation_feedback._session + assert session1 != session2 +def test_address_validation_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AddressValidationGrpcTransport( + 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_address_validation_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AddressValidationGrpcAsyncIOTransport( + 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.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) +def test_address_validation_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) +def test_address_validation_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = AddressValidationClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = AddressValidationClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AddressValidationClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = AddressValidationClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = AddressValidationClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AddressValidationClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = AddressValidationClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = AddressValidationClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AddressValidationClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = AddressValidationClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = AddressValidationClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AddressValidationClient.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 = AddressValidationClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = AddressValidationClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AddressValidationClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.AddressValidationTransport, '_prep_wrapped_messages') as prep: + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.AddressValidationTransport, '_prep_wrapped_messages') as prep: + transport_class = AddressValidationClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = AddressValidationAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close(): + transports = { + "rest": "_session", + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'rest', + 'grpc', + ] + for transport in transports: + client = AddressValidationClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (AddressValidationClient, transports.AddressValidationGrpcTransport), + (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) From 5bbc7c6235b34f0c842cff773603d6171d6a5125 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Mon, 19 Feb 2024 20:55:37 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../v1/.coveragerc | 13 - .../google-maps-addressvalidation/v1/.flake8 | 33 - .../v1/MANIFEST.in | 2 - .../v1/README.rst | 49 - .../v1/docs/_static/custom.css | 3 - .../address_validation.rst | 6 - .../docs/addressvalidation_v1/services_.rst | 6 - .../v1/docs/addressvalidation_v1/types_.rst | 6 - .../v1/docs/conf.py | 376 ---- .../v1/docs/index.rst | 7 - .../google/maps/addressvalidation/__init__.py | 55 - .../maps/addressvalidation/gapic_version.py | 16 - .../v1/google/maps/addressvalidation/py.typed | 2 - .../maps/addressvalidation_v1/__init__.py | 56 - .../addressvalidation_v1/gapic_metadata.json | 58 - .../addressvalidation_v1/gapic_version.py | 16 - .../google/maps/addressvalidation_v1/py.typed | 2 - .../addressvalidation_v1/services/__init__.py | 15 - .../services/address_validation/__init__.py | 22 - .../address_validation/async_client.py | 392 ---- .../services/address_validation/client.py | 737 ------- .../address_validation/transports/__init__.py | 38 - .../address_validation/transports/base.py | 165 -- .../address_validation/transports/grpc.py | 295 --- .../transports/grpc_asyncio.py | 294 --- .../address_validation/transports/rest.py | 421 ---- .../addressvalidation_v1/types/__init__.py | 56 - .../addressvalidation_v1/types/address.py | 244 --- .../types/address_validation_service.py | 413 ---- .../addressvalidation_v1/types/geocode.py | 132 -- .../addressvalidation_v1/types/metadata_.py | 76 - .../addressvalidation_v1/types/usps_data.py | 493 ----- .../google-maps-addressvalidation/v1/mypy.ini | 3 - .../v1/noxfile.py | 253 --- ...ation_provide_validation_feedback_async.py | 53 - ...dation_provide_validation_feedback_sync.py | 53 - ...dress_validation_validate_address_async.py | 51 - ...ddress_validation_validate_address_sync.py | 51 - ...data_google.maps.addressvalidation.v1.json | 321 --- .../fixup_addressvalidation_v1_keywords.py | 177 -- .../google-maps-addressvalidation/v1/setup.py | 92 - .../v1/testing/constraints-3.10.txt | 7 - .../v1/testing/constraints-3.11.txt | 7 - .../v1/testing/constraints-3.12.txt | 7 - .../v1/testing/constraints-3.7.txt | 11 - .../v1/testing/constraints-3.8.txt | 7 - .../v1/testing/constraints-3.9.txt | 7 - .../v1/tests/__init__.py | 16 - .../v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../gapic/addressvalidation_v1/__init__.py | 16 - .../test_address_validation.py | 1944 ----------------- .../addressvalidation_v1/types/address.py | 11 +- .../types/address_validation_service.py | 34 +- .../addressvalidation_v1/types/usps_data.py | 149 +- .../fixup_addressvalidation_v1_keywords.py | 2 +- 56 files changed, 179 insertions(+), 7624 deletions(-) delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/.flake8 delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/README.rst delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/setup.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py delete mode 100644 owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc b/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc deleted file mode 100644 index e4692ea29e6d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/maps/addressvalidation/__init__.py - google/maps/addressvalidation/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 b/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 deleted file mode 100644 index 29227d4cf419..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/.flake8 +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in b/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in deleted file mode 100644 index 6d21915b6647..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/maps/addressvalidation *.py -recursive-include google/maps/addressvalidation_v1 *.py diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/README.rst b/owl-bot-staging/google-maps-addressvalidation/v1/README.rst deleted file mode 100644 index 6bce085c3115..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Maps Addressvalidation 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 Maps Addressvalidation 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/google-maps-addressvalidation/v1/docs/_static/custom.css b/owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css deleted file mode 100644 index 06423be0b592..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/_static/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -dl.field-list > dt { - min-width: 100px -} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst deleted file mode 100644 index bfcddd27291d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/address_validation.rst +++ /dev/null @@ -1,6 +0,0 @@ -AddressValidation ------------------------------------ - -.. automodule:: google.maps.addressvalidation_v1.services.address_validation - :members: - :inherited-members: diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst deleted file mode 100644 index 44fb49f7a1cb..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/services_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Maps Addressvalidation v1 API -================================================= -.. toctree:: - :maxdepth: 2 - - address_validation diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst deleted file mode 100644 index 454488a7c78b..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/addressvalidation_v1/types_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Maps Addressvalidation v1 API -============================================== - -.. automodule:: google.maps.addressvalidation_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py b/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py deleted file mode 100644 index df0d7356b9b9..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# -# google-maps-addressvalidation documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-maps-addressvalidation" -copyright = u"2023, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Maps 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-maps-addressvalidation-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - root_doc, - "google-maps-addressvalidation.tex", - u"google-maps-addressvalidation Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - root_doc, - "google-maps-addressvalidation", - u"Google Maps Addressvalidation Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - root_doc, - "google-maps-addressvalidation", - u"google-maps-addressvalidation Documentation", - author, - "google-maps-addressvalidation", - "GAPIC library for Google Maps Addressvalidation 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/google-maps-addressvalidation/v1/docs/index.rst b/owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst deleted file mode 100644 index de0c00b3a9b4..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - addressvalidation_v1/services - addressvalidation_v1/types diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py deleted file mode 100644 index 76a7b79861a1..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/__init__.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.maps.addressvalidation import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.maps.addressvalidation_v1.services.address_validation.client import AddressValidationClient -from google.maps.addressvalidation_v1.services.address_validation.async_client import AddressValidationAsyncClient - -from google.maps.addressvalidation_v1.types.address import Address -from google.maps.addressvalidation_v1.types.address import AddressComponent -from google.maps.addressvalidation_v1.types.address import ComponentName -from google.maps.addressvalidation_v1.types.address_validation_service import ProvideValidationFeedbackRequest -from google.maps.addressvalidation_v1.types.address_validation_service import ProvideValidationFeedbackResponse -from google.maps.addressvalidation_v1.types.address_validation_service import ValidateAddressRequest -from google.maps.addressvalidation_v1.types.address_validation_service import ValidateAddressResponse -from google.maps.addressvalidation_v1.types.address_validation_service import ValidationResult -from google.maps.addressvalidation_v1.types.address_validation_service import Verdict -from google.maps.addressvalidation_v1.types.geocode import Geocode -from google.maps.addressvalidation_v1.types.geocode import PlusCode -from google.maps.addressvalidation_v1.types.metadata_ import AddressMetadata -from google.maps.addressvalidation_v1.types.usps_data import UspsAddress -from google.maps.addressvalidation_v1.types.usps_data import UspsData - -__all__ = ('AddressValidationClient', - 'AddressValidationAsyncClient', - 'Address', - 'AddressComponent', - 'ComponentName', - 'ProvideValidationFeedbackRequest', - 'ProvideValidationFeedbackResponse', - 'ValidateAddressRequest', - 'ValidateAddressResponse', - 'ValidationResult', - 'Verdict', - 'Geocode', - 'PlusCode', - 'AddressMetadata', - 'UspsAddress', - 'UspsData', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py deleted file mode 100644 index 360a0d13ebdd..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed deleted file mode 100644 index 1e46c59c8e22..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-maps-addressvalidation package uses inline types. diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py deleted file mode 100644 index 6ba74e7a6bb6..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/__init__.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from google.maps.addressvalidation_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.address_validation import AddressValidationClient -from .services.address_validation import AddressValidationAsyncClient - -from .types.address import Address -from .types.address import AddressComponent -from .types.address import ComponentName -from .types.address_validation_service import ProvideValidationFeedbackRequest -from .types.address_validation_service import ProvideValidationFeedbackResponse -from .types.address_validation_service import ValidateAddressRequest -from .types.address_validation_service import ValidateAddressResponse -from .types.address_validation_service import ValidationResult -from .types.address_validation_service import Verdict -from .types.geocode import Geocode -from .types.geocode import PlusCode -from .types.metadata_ import AddressMetadata -from .types.usps_data import UspsAddress -from .types.usps_data import UspsData - -__all__ = ( - 'AddressValidationAsyncClient', -'Address', -'AddressComponent', -'AddressMetadata', -'AddressValidationClient', -'ComponentName', -'Geocode', -'PlusCode', -'ProvideValidationFeedbackRequest', -'ProvideValidationFeedbackResponse', -'UspsAddress', -'UspsData', -'ValidateAddressRequest', -'ValidateAddressResponse', -'ValidationResult', -'Verdict', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json deleted file mode 100644 index c521c066be76..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_metadata.json +++ /dev/null @@ -1,58 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.maps.addressvalidation_v1", - "protoPackage": "google.maps.addressvalidation.v1", - "schema": "1.0", - "services": { - "AddressValidation": { - "clients": { - "grpc": { - "libraryClient": "AddressValidationClient", - "rpcs": { - "ProvideValidationFeedback": { - "methods": [ - "provide_validation_feedback" - ] - }, - "ValidateAddress": { - "methods": [ - "validate_address" - ] - } - } - }, - "grpc-async": { - "libraryClient": "AddressValidationAsyncClient", - "rpcs": { - "ProvideValidationFeedback": { - "methods": [ - "provide_validation_feedback" - ] - }, - "ValidateAddress": { - "methods": [ - "validate_address" - ] - } - } - }, - "rest": { - "libraryClient": "AddressValidationClient", - "rpcs": { - "ProvideValidationFeedback": { - "methods": [ - "provide_validation_feedback" - ] - }, - "ValidateAddress": { - "methods": [ - "validate_address" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py deleted file mode 100644 index 360a0d13ebdd..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -__version__ = "0.0.0" # {x-release-please-version} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed deleted file mode 100644 index 1e46c59c8e22..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-maps-addressvalidation package uses inline types. diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py deleted file mode 100644 index 89a37dc92c5a..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py deleted file mode 100644 index 0058d06ca2d8..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .client import AddressValidationClient -from .async_client import AddressValidationAsyncClient - -__all__ = ( - 'AddressValidationClient', - 'AddressValidationAsyncClient', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py deleted file mode 100644 index e3500e42f9fa..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/async_client.py +++ /dev/null @@ -1,392 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.maps.addressvalidation_v1 import gapic_version as package_version - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore - -from google.maps.addressvalidation_v1.types import address_validation_service -from .transports.base import AddressValidationTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import AddressValidationGrpcAsyncIOTransport -from .client import AddressValidationClient - - -class AddressValidationAsyncClient: - """The service for validating addresses.""" - - _client: AddressValidationClient - - # Copy defaults from the synchronous client for use here. - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = AddressValidationClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = AddressValidationClient.DEFAULT_MTLS_ENDPOINT - _DEFAULT_ENDPOINT_TEMPLATE = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE - _DEFAULT_UNIVERSE = AddressValidationClient._DEFAULT_UNIVERSE - - common_billing_account_path = staticmethod(AddressValidationClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(AddressValidationClient.parse_common_billing_account_path) - common_folder_path = staticmethod(AddressValidationClient.common_folder_path) - parse_common_folder_path = staticmethod(AddressValidationClient.parse_common_folder_path) - common_organization_path = staticmethod(AddressValidationClient.common_organization_path) - parse_common_organization_path = staticmethod(AddressValidationClient.parse_common_organization_path) - common_project_path = staticmethod(AddressValidationClient.common_project_path) - parse_common_project_path = staticmethod(AddressValidationClient.parse_common_project_path) - common_location_path = staticmethod(AddressValidationClient.common_location_path) - parse_common_location_path = staticmethod(AddressValidationClient.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: - AddressValidationAsyncClient: The constructed client. - """ - return AddressValidationClient.from_service_account_info.__func__(AddressValidationAsyncClient, 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: - AddressValidationAsyncClient: The constructed client. - """ - return AddressValidationClient.from_service_account_file.__func__(AddressValidationAsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - return AddressValidationClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> AddressValidationTransport: - """Returns the transport used by the client instance. - - Returns: - AddressValidationTransport: The transport used by the client instance. - """ - return self._client.transport - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._client._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used - by the client instance. - """ - return self._client._universe_domain - - get_transport_class = functools.partial(type(AddressValidationClient).get_transport_class, type(AddressValidationClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, AddressValidationTransport] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the address validation async client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.AddressValidationTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): - Custom options for the client. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto-switch to the - default mTLS endpoint if client certificate is present; this is - the default value). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = AddressValidationClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def validate_address(self, - request: Optional[Union[address_validation_service.ValidateAddressRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> address_validation_service.ValidateAddressResponse: - r"""Validates an address. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.maps import addressvalidation_v1 - - async def sample_validate_address(): - # Create a client - client = addressvalidation_v1.AddressValidationAsyncClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ValidateAddressRequest( - ) - - # Make the request - response = await client.validate_address(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.maps.addressvalidation_v1.types.ValidateAddressRequest, dict]]): - The request object. The request for validating an - address. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.maps.addressvalidation_v1.types.ValidateAddressResponse: - The response to an address validation - request. - - """ - # Create or coerce a protobuf request object. - request = address_validation_service.ValidateAddressRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.validate_address, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def provide_validation_feedback(self, - request: Optional[Union[address_validation_service.ProvideValidationFeedbackRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> address_validation_service.ProvideValidationFeedbackResponse: - r"""Feedback about the outcome of the sequence of validation - attempts. This should be the last call made after a sequence of - validation calls for the same address, and should be called once - the transaction is concluded. This should only be sent once for - the sequence of ``ValidateAddress`` requests needed to validate - an address fully. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.maps import addressvalidation_v1 - - async def sample_provide_validation_feedback(): - # Create a client - client = addressvalidation_v1.AddressValidationAsyncClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ProvideValidationFeedbackRequest( - conclusion="UNUSED", - response_id="response_id_value", - ) - - # Make the request - response = await client.provide_validation_feedback(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest, dict]]): - The request object. The request for sending validation - feedback. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse: - The response for validation feedback. - - The response is empty if the feedback is - sent successfully. - - """ - # Create or coerce a protobuf request object. - request = address_validation_service.ProvideValidationFeedbackRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.provide_validation_feedback, - default_timeout=None, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "AddressValidationAsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "AddressValidationAsyncClient", -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py deleted file mode 100644 index 329d2603d9da..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/client.py +++ /dev/null @@ -1,737 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast -import warnings - -from google.maps.addressvalidation_v1 import gapic_version as package_version - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -from google.maps.addressvalidation_v1.types import address_validation_service -from .transports.base import AddressValidationTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import AddressValidationGrpcTransport -from .transports.grpc_asyncio import AddressValidationGrpcAsyncIOTransport -from .transports.rest import AddressValidationRestTransport - - -class AddressValidationClientMeta(type): - """Metaclass for the AddressValidation 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[AddressValidationTransport]] - _transport_registry["grpc"] = AddressValidationGrpcTransport - _transport_registry["grpc_asyncio"] = AddressValidationGrpcAsyncIOTransport - _transport_registry["rest"] = AddressValidationRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[AddressValidationTransport]: - """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 AddressValidationClient(metaclass=AddressValidationClientMeta): - """The service for validating addresses.""" - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = "addressvalidation.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - _DEFAULT_ENDPOINT_TEMPLATE = "addressvalidation.{UNIVERSE_DOMAIN}" - _DEFAULT_UNIVERSE = "googleapis.com" - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - AddressValidationClient: 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: - AddressValidationClient: 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) -> AddressValidationTransport: - """Returns the transport used by the client instance. - - Returns: - AddressValidationTransport: 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 {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Deprecated. Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variable is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - - warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", - DeprecationWarning) - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - @staticmethod - def _read_environment_variables(): - """Returns the environment variables used by the client. - - Returns: - Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, - GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. - - Raises: - ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not - any of ["true", "false"]. - google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT - is not any of ["auto", "never", "always"]. - """ - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() - universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - return use_client_cert == "true", use_mtls_endpoint, universe_domain_env - - @staticmethod - def _get_client_cert_source(provided_cert_source, use_cert_flag): - """Return the client cert source to be used by the client. - - Args: - provided_cert_source (bytes): The client certificate source provided. - use_cert_flag (bool): A flag indicating whether to use the client certificate. - - Returns: - bytes or None: The client cert source to be used by the client. - """ - client_cert_source = None - if use_cert_flag: - if provided_cert_source: - client_cert_source = provided_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - return client_cert_source - - @staticmethod - def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): - """Return the API endpoint used by the client. - - Args: - api_override (str): The API endpoint override. If specified, this is always - the return value of this function and the other arguments are not used. - client_cert_source (bytes): The client certificate source used by the client. - universe_domain (str): The universe domain used by the client. - use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. - Possible values are "always", "auto", or "never". - - Returns: - str: The API endpoint to be used by the client. - """ - if api_override is not None: - api_endpoint = api_override - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - _default_universe = AddressValidationClient._DEFAULT_UNIVERSE - if universe_domain != _default_universe: - raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") - api_endpoint = AddressValidationClient.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) - return api_endpoint - - @staticmethod - def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: - """Return the universe domain used by the client. - - Args: - client_universe_domain (Optional[str]): The universe domain configured via the client options. - universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. - - Returns: - str: The universe domain to be used by the client. - - Raises: - ValueError: If the universe domain is an empty string. - """ - universe_domain = AddressValidationClient._DEFAULT_UNIVERSE - if client_universe_domain is not None: - universe_domain = client_universe_domain - elif universe_domain_env is not None: - universe_domain = universe_domain_env - if len(universe_domain.strip()) == 0: - raise ValueError("Universe Domain cannot be an empty string.") - return universe_domain - - @staticmethod - def _compare_universes(client_universe: str, - credentials: ga_credentials.Credentials) -> bool: - """Returns True iff the universe domains used by the client and credentials match. - - Args: - client_universe (str): The universe domain configured via the client options. - credentials (ga_credentials.Credentials): The credentials being used in the client. - - Returns: - bool: True iff client_universe matches the universe in credentials. - - Raises: - ValueError: when client_universe does not match the universe in credentials. - """ - - default_universe = AddressValidationClient._DEFAULT_UNIVERSE - credentials_universe = getattr(credentials, "universe_domain", default_universe) - - if client_universe != credentials_universe: - raise ValueError("The configured universe domain " - f"({client_universe}) does not match the universe domain " - f"found in the credentials ({credentials_universe}). " - "If you haven't configured the universe domain explicitly, " - f"`{default_universe}` is the default.") - return True - - def _validate_universe_domain(self): - """Validates client's and credentials' universe domains are consistent. - - Returns: - bool: True iff the configured universe domain is valid. - - Raises: - ValueError: If the configured universe domain is not valid. - """ - self._is_universe_domain_valid = (self._is_universe_domain_valid or - AddressValidationClient._compare_universes(self.universe_domain, self.transport._credentials)) - return self._is_universe_domain_valid - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used by the client instance. - """ - return self._universe_domain - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, AddressValidationTransport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the address validation 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, AddressValidationTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): - Custom options for the client. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto-switch to the - default mTLS endpoint if client certificate is present; this is - the default value). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that the ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client_options = client_options - if isinstance(self._client_options, dict): - self._client_options = client_options_lib.from_dict(self._client_options) - if self._client_options is None: - self._client_options = client_options_lib.ClientOptions() - self._client_options = cast(client_options_lib.ClientOptions, self._client_options) - - universe_domain_opt = getattr(self._client_options, 'universe_domain', None) - - self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = AddressValidationClient._read_environment_variables() - self._client_cert_source = AddressValidationClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) - self._universe_domain = AddressValidationClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) - self._api_endpoint = None # updated below, depending on `transport` - - # Initialize the universe domain validation. - self._is_universe_domain_valid = False - - api_key_value = getattr(self._client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - transport_provided = isinstance(transport, AddressValidationTransport) - if transport_provided: - # transport is a AddressValidationTransport instance. - if credentials or self._client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if self._client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = cast(AddressValidationTransport, transport) - self._api_endpoint = self._transport.host - - self._api_endpoint = (self._api_endpoint or - AddressValidationClient._get_api_endpoint( - self._client_options.api_endpoint, - self._client_cert_source, - self._universe_domain, - self._use_mtls_endpoint)) - - if not transport_provided: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(cast(str, transport)) - self._transport = Transport( - credentials=credentials, - credentials_file=self._client_options.credentials_file, - host=self._api_endpoint, - scopes=self._client_options.scopes, - client_cert_source_for_mtls=self._client_cert_source, - quota_project_id=self._client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=self._client_options.api_audience, - ) - - def validate_address(self, - request: Optional[Union[address_validation_service.ValidateAddressRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> address_validation_service.ValidateAddressResponse: - r"""Validates an address. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.maps import addressvalidation_v1 - - def sample_validate_address(): - # Create a client - client = addressvalidation_v1.AddressValidationClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ValidateAddressRequest( - ) - - # Make the request - response = client.validate_address(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.maps.addressvalidation_v1.types.ValidateAddressRequest, dict]): - The request object. The request for validating an - address. - 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.maps.addressvalidation_v1.types.ValidateAddressResponse: - The response to an address validation - request. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a address_validation_service.ValidateAddressRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, address_validation_service.ValidateAddressRequest): - request = address_validation_service.ValidateAddressRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.validate_address] - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def provide_validation_feedback(self, - request: Optional[Union[address_validation_service.ProvideValidationFeedbackRequest, dict]] = None, - *, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> address_validation_service.ProvideValidationFeedbackResponse: - r"""Feedback about the outcome of the sequence of validation - attempts. This should be the last call made after a sequence of - validation calls for the same address, and should be called once - the transaction is concluded. This should only be sent once for - the sequence of ``ValidateAddress`` requests needed to validate - an address fully. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.maps import addressvalidation_v1 - - def sample_provide_validation_feedback(): - # Create a client - client = addressvalidation_v1.AddressValidationClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ProvideValidationFeedbackRequest( - conclusion="UNUSED", - response_id="response_id_value", - ) - - # Make the request - response = client.provide_validation_feedback(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest, dict]): - The request object. The request for sending validation - feedback. - 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.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse: - The response for validation feedback. - - The response is empty if the feedback is - sent successfully. - - """ - # Create or coerce a protobuf request object. - # Minor optimization to avoid making a copy if the user passes - # in a address_validation_service.ProvideValidationFeedbackRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, address_validation_service.ProvideValidationFeedbackRequest): - request = address_validation_service.ProvideValidationFeedbackRequest(request) - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.provide_validation_feedback] - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "AddressValidationClient": - return self - - def __exit__(self, type, value, traceback): - """Releases underlying transport's resources. - - .. warning:: - ONLY use as a context manager if the transport is NOT shared - with other clients! Exiting the with block will CLOSE the transport - and may cause errors in other clients! - """ - self.transport.close() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__all__ = ( - "AddressValidationClient", -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py deleted file mode 100644 index 5d08151012a0..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import AddressValidationTransport -from .grpc import AddressValidationGrpcTransport -from .grpc_asyncio import AddressValidationGrpcAsyncIOTransport -from .rest import AddressValidationRestTransport -from .rest import AddressValidationRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[AddressValidationTransport]] -_transport_registry['grpc'] = AddressValidationGrpcTransport -_transport_registry['grpc_asyncio'] = AddressValidationGrpcAsyncIOTransport -_transport_registry['rest'] = AddressValidationRestTransport - -__all__ = ( - 'AddressValidationTransport', - 'AddressValidationGrpcTransport', - 'AddressValidationGrpcAsyncIOTransport', - 'AddressValidationRestTransport', - 'AddressValidationRestInterceptor', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py deleted file mode 100644 index 264b5c31f267..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/base.py +++ /dev/null @@ -1,165 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union - -from google.maps.addressvalidation_v1 import gapic_version as package_version - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.maps.addressvalidation_v1.types import address_validation_service - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class AddressValidationTransport(abc.ABC): - """Abstract transport class for AddressValidation.""" - - AUTH_SCOPES = ( - ) - - DEFAULT_HOST: str = 'addressvalidation.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'addressvalidation.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - @property - def host(self): - return self._host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.validate_address: gapic_v1.method.wrap_method( - self.validate_address, - default_timeout=None, - client_info=client_info, - ), - self.provide_validation_feedback: gapic_v1.method.wrap_method( - self.provide_validation_feedback, - default_timeout=None, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def validate_address(self) -> Callable[ - [address_validation_service.ValidateAddressRequest], - Union[ - address_validation_service.ValidateAddressResponse, - Awaitable[address_validation_service.ValidateAddressResponse] - ]]: - raise NotImplementedError() - - @property - def provide_validation_feedback(self) -> Callable[ - [address_validation_service.ProvideValidationFeedbackRequest], - Union[ - address_validation_service.ProvideValidationFeedbackResponse, - Awaitable[address_validation_service.ProvideValidationFeedbackResponse] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'AddressValidationTransport', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py deleted file mode 100644 index 82b8e24a4164..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc.py +++ /dev/null @@ -1,295 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.maps.addressvalidation_v1.types import address_validation_service -from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO - - -class AddressValidationGrpcTransport(AddressValidationTransport): - """gRPC backend transport for AddressValidation. - - The service for validating addresses. - - 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 = 'addressvalidation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'addressvalidation.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'addressvalidation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def validate_address(self) -> Callable[ - [address_validation_service.ValidateAddressRequest], - address_validation_service.ValidateAddressResponse]: - r"""Return a callable for the validate address method over gRPC. - - Validates an address. - - Returns: - Callable[[~.ValidateAddressRequest], - ~.ValidateAddressResponse]: - 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 'validate_address' not in self._stubs: - self._stubs['validate_address'] = self.grpc_channel.unary_unary( - '/google.maps.addressvalidation.v1.AddressValidation/ValidateAddress', - request_serializer=address_validation_service.ValidateAddressRequest.serialize, - response_deserializer=address_validation_service.ValidateAddressResponse.deserialize, - ) - return self._stubs['validate_address'] - - @property - def provide_validation_feedback(self) -> Callable[ - [address_validation_service.ProvideValidationFeedbackRequest], - address_validation_service.ProvideValidationFeedbackResponse]: - r"""Return a callable for the provide validation feedback method over gRPC. - - Feedback about the outcome of the sequence of validation - attempts. This should be the last call made after a sequence of - validation calls for the same address, and should be called once - the transaction is concluded. This should only be sent once for - the sequence of ``ValidateAddress`` requests needed to validate - an address fully. - - Returns: - Callable[[~.ProvideValidationFeedbackRequest], - ~.ProvideValidationFeedbackResponse]: - 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 'provide_validation_feedback' not in self._stubs: - self._stubs['provide_validation_feedback'] = self.grpc_channel.unary_unary( - '/google.maps.addressvalidation.v1.AddressValidation/ProvideValidationFeedback', - request_serializer=address_validation_service.ProvideValidationFeedbackRequest.serialize, - response_deserializer=address_validation_service.ProvideValidationFeedbackResponse.deserialize, - ) - return self._stubs['provide_validation_feedback'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'AddressValidationGrpcTransport', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py deleted file mode 100644 index 6f28e6b8d385..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/grpc_asyncio.py +++ /dev/null @@ -1,294 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.maps.addressvalidation_v1.types import address_validation_service -from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO -from .grpc import AddressValidationGrpcTransport - - -class AddressValidationGrpcAsyncIOTransport(AddressValidationTransport): - """gRPC AsyncIO backend transport for AddressValidation. - - The service for validating addresses. - - 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 = 'addressvalidation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'addressvalidation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'addressvalidation.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def validate_address(self) -> Callable[ - [address_validation_service.ValidateAddressRequest], - Awaitable[address_validation_service.ValidateAddressResponse]]: - r"""Return a callable for the validate address method over gRPC. - - Validates an address. - - Returns: - Callable[[~.ValidateAddressRequest], - Awaitable[~.ValidateAddressResponse]]: - 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 'validate_address' not in self._stubs: - self._stubs['validate_address'] = self.grpc_channel.unary_unary( - '/google.maps.addressvalidation.v1.AddressValidation/ValidateAddress', - request_serializer=address_validation_service.ValidateAddressRequest.serialize, - response_deserializer=address_validation_service.ValidateAddressResponse.deserialize, - ) - return self._stubs['validate_address'] - - @property - def provide_validation_feedback(self) -> Callable[ - [address_validation_service.ProvideValidationFeedbackRequest], - Awaitable[address_validation_service.ProvideValidationFeedbackResponse]]: - r"""Return a callable for the provide validation feedback method over gRPC. - - Feedback about the outcome of the sequence of validation - attempts. This should be the last call made after a sequence of - validation calls for the same address, and should be called once - the transaction is concluded. This should only be sent once for - the sequence of ``ValidateAddress`` requests needed to validate - an address fully. - - Returns: - Callable[[~.ProvideValidationFeedbackRequest], - Awaitable[~.ProvideValidationFeedbackResponse]]: - 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 'provide_validation_feedback' not in self._stubs: - self._stubs['provide_validation_feedback'] = self.grpc_channel.unary_unary( - '/google.maps.addressvalidation.v1.AddressValidation/ProvideValidationFeedback', - request_serializer=address_validation_service.ProvideValidationFeedbackRequest.serialize, - response_deserializer=address_validation_service.ProvideValidationFeedbackResponse.deserialize, - ) - return self._stubs['provide_validation_feedback'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'AddressValidationGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py deleted file mode 100644 index 1dfbd2a3e525..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/services/address_validation/transports/rest.py +++ /dev/null @@ -1,421 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - - -from google.maps.addressvalidation_v1.types import address_validation_service - -from .base import AddressValidationTransport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class AddressValidationRestInterceptor: - """Interceptor for AddressValidation. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the AddressValidationRestTransport. - - .. code-block:: python - class MyCustomAddressValidationInterceptor(AddressValidationRestInterceptor): - def pre_provide_validation_feedback(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_provide_validation_feedback(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_validate_address(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_validate_address(self, response): - logging.log(f"Received response: {response}") - return response - - transport = AddressValidationRestTransport(interceptor=MyCustomAddressValidationInterceptor()) - client = AddressValidationClient(transport=transport) - - - """ - def pre_provide_validation_feedback(self, request: address_validation_service.ProvideValidationFeedbackRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[address_validation_service.ProvideValidationFeedbackRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for provide_validation_feedback - - Override in a subclass to manipulate the request or metadata - before they are sent to the AddressValidation server. - """ - return request, metadata - - def post_provide_validation_feedback(self, response: address_validation_service.ProvideValidationFeedbackResponse) -> address_validation_service.ProvideValidationFeedbackResponse: - """Post-rpc interceptor for provide_validation_feedback - - Override in a subclass to manipulate the response - after it is returned by the AddressValidation server but before - it is returned to user code. - """ - return response - def pre_validate_address(self, request: address_validation_service.ValidateAddressRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[address_validation_service.ValidateAddressRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for validate_address - - Override in a subclass to manipulate the request or metadata - before they are sent to the AddressValidation server. - """ - return request, metadata - - def post_validate_address(self, response: address_validation_service.ValidateAddressResponse) -> address_validation_service.ValidateAddressResponse: - """Post-rpc interceptor for validate_address - - Override in a subclass to manipulate the response - after it is returned by the AddressValidation server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class AddressValidationRestStub: - _session: AuthorizedSession - _host: str - _interceptor: AddressValidationRestInterceptor - - -class AddressValidationRestTransport(AddressValidationTransport): - """REST backend transport for AddressValidation. - - The service for validating addresses. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'addressvalidation.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[Callable[[ - ], Tuple[bytes, bytes]]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - url_scheme: str = 'https', - interceptor: Optional[AddressValidationRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'addressvalidation.googleapis.com'). - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or AddressValidationRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ProvideValidationFeedback(AddressValidationRestStub): - def __hash__(self): - return hash("ProvideValidationFeedback") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: address_validation_service.ProvideValidationFeedbackRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> address_validation_service.ProvideValidationFeedbackResponse: - r"""Call the provide validation - feedback method over HTTP. - - Args: - request (~.address_validation_service.ProvideValidationFeedbackRequest): - The request object. The request for sending validation - feedback. - 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: - ~.address_validation_service.ProvideValidationFeedbackResponse: - The response for validation feedback. - - The response is empty if the feedback is - sent successfully. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1:provideValidationFeedback', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_provide_validation_feedback(request, metadata) - pb_request = address_validation_service.ProvideValidationFeedbackRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = address_validation_service.ProvideValidationFeedbackResponse() - pb_resp = address_validation_service.ProvideValidationFeedbackResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_provide_validation_feedback(resp) - return resp - - class _ValidateAddress(AddressValidationRestStub): - def __hash__(self): - return hash("ValidateAddress") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: address_validation_service.ValidateAddressRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> address_validation_service.ValidateAddressResponse: - r"""Call the validate address method over HTTP. - - Args: - request (~.address_validation_service.ValidateAddressRequest): - The request object. The request for validating an - address. - 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: - ~.address_validation_service.ValidateAddressResponse: - The response to an address validation - request. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1:validateAddress', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_validate_address(request, metadata) - pb_request = address_validation_service.ValidateAddressRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = address_validation_service.ValidateAddressResponse() - pb_resp = address_validation_service.ValidateAddressResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_validate_address(resp) - return resp - - @property - def provide_validation_feedback(self) -> Callable[ - [address_validation_service.ProvideValidationFeedbackRequest], - address_validation_service.ProvideValidationFeedbackResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ProvideValidationFeedback(self._session, self._host, self._interceptor) # type: ignore - - @property - def validate_address(self) -> Callable[ - [address_validation_service.ValidateAddressRequest], - address_validation_service.ValidateAddressResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ValidateAddress(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'AddressValidationRestTransport', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py deleted file mode 100644 index 33b0cf3c0a05..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/__init__.py +++ /dev/null @@ -1,56 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from .address import ( - Address, - AddressComponent, - ComponentName, -) -from .address_validation_service import ( - ProvideValidationFeedbackRequest, - ProvideValidationFeedbackResponse, - ValidateAddressRequest, - ValidateAddressResponse, - ValidationResult, - Verdict, -) -from .geocode import ( - Geocode, - PlusCode, -) -from .metadata_ import ( - AddressMetadata, -) -from .usps_data import ( - UspsAddress, - UspsData, -) - -__all__ = ( - 'Address', - 'AddressComponent', - 'ComponentName', - 'ProvideValidationFeedbackRequest', - 'ProvideValidationFeedbackResponse', - 'ValidateAddressRequest', - 'ValidateAddressResponse', - 'ValidationResult', - 'Verdict', - 'Geocode', - 'PlusCode', - 'AddressMetadata', - 'UspsAddress', - 'UspsData', -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py deleted file mode 100644 index 8e6e77e34d1a..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address.py +++ /dev/null @@ -1,244 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.type import postal_address_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.maps.addressvalidation.v1', - manifest={ - 'Address', - 'AddressComponent', - 'ComponentName', - }, -) - - -class Address(proto.Message): - r"""Details of the post-processed address. Post-processing - includes correcting misspelled parts of the address, replacing - incorrect parts, and inferring missing parts. - - Attributes: - formatted_address (str): - The post-processed address, formatted as a - single-line address following the address - formatting rules of the region where the address - is located. - postal_address (google.type.postal_address_pb2.PostalAddress): - The post-processed address represented as a - postal address. - address_components (MutableSequence[google.maps.addressvalidation_v1.types.AddressComponent]): - Unordered list. The individual address - components of the formatted and corrected - address, along with validation information. This - provides information on the validation status of - the individual components. - - Address components are not ordered in a - particular way. Do not make any assumptions on - the ordering of the address components in the - list. - missing_component_types (MutableSequence[str]): - The types of components that were expected to be present in - a correctly formatted mailing address but were not found in - the input AND could not be inferred. Components of this type - are not present in ``formatted_address``, - ``postal_address``, or ``address_components``. An example - might be ``['street_number', 'route']`` for an input like - "Boulder, Colorado, 80301, USA". The list of possible types - can be found - `here `__. - unconfirmed_component_types (MutableSequence[str]): - The types of the components that are present in the - ``address_components`` but could not be confirmed to be - correct. This field is provided for the sake of convenience: - its contents are equivalent to iterating through the - ``address_components`` to find the types of all the - components where the - [confirmation_level][google.maps.addressvalidation.v1.AddressComponent.confirmation_level] - is not - [CONFIRMED][google.maps.addressvalidation.v1.AddressComponent.ConfirmationLevel.CONFIRMED] - or the - [inferred][google.maps.addressvalidation.v1.AddressComponent.inferred] - flag is not set to ``true``. The list of possible types can - be found - `here `__. - unresolved_tokens (MutableSequence[str]): - Any tokens in the input that could not be resolved. This - might be an input that was not recognized as a valid part of - an address (for example in an input like "123235253253 Main - St, San Francisco, CA, 94105", the unresolved tokens may - look like ``["123235253253"]`` since that does not look like - a valid street number. - """ - - formatted_address: str = proto.Field( - proto.STRING, - number=2, - ) - postal_address: postal_address_pb2.PostalAddress = proto.Field( - proto.MESSAGE, - number=3, - message=postal_address_pb2.PostalAddress, - ) - address_components: MutableSequence['AddressComponent'] = proto.RepeatedField( - proto.MESSAGE, - number=4, - message='AddressComponent', - ) - missing_component_types: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=5, - ) - unconfirmed_component_types: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=6, - ) - unresolved_tokens: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=7, - ) - - -class AddressComponent(proto.Message): - r"""Represents an address component, such as a street, city, or - state. - - Attributes: - component_name (google.maps.addressvalidation_v1.types.ComponentName): - The name for this component. - component_type (str): - The type of the address component. See `Table 2: Additional - types returned by the Places - service `__ - for a list of possible types. - confirmation_level (google.maps.addressvalidation_v1.types.AddressComponent.ConfirmationLevel): - Indicates the level of certainty that we have - that the component is correct. - inferred (bool): - Indicates that the component was not part of - the input, but we inferred it for the address - location and believe it should be provided for a - complete address. - spell_corrected (bool): - Indicates a correction to a misspelling in - the component name. The API does not always - flag changes from one spelling variant to - another, such as when changing "centre" to - "center". It also does not always flag common - misspellings, such as when changing - "Amphitheater Pkwy" to "Amphitheatre Pkwy". - replaced (bool): - Indicates the name of the component was - replaced with a completely different one, for - example a wrong postal code being replaced with - one that is correct for the address. This is not - a cosmetic change, the input component has been - changed to a different one. - unexpected (bool): - Indicates an address component that is not - expected to be present in a postal address for - the given region. We have retained it only - because it was part of the input. - """ - class ConfirmationLevel(proto.Enum): - r"""The different possible values for confirmation levels. - - Values: - CONFIRMATION_LEVEL_UNSPECIFIED (0): - Default value. This value is unused. - CONFIRMED (1): - We were able to verify that this component - exists and makes sense in the context of the - rest of the address. - UNCONFIRMED_BUT_PLAUSIBLE (2): - This component could not be confirmed, but it - is plausible that it exists. For example, a - street number within a known valid range of - numbers on a street where specific house numbers - are not known. - UNCONFIRMED_AND_SUSPICIOUS (3): - This component was not confirmed and is - likely to be wrong. For example, a neighborhood - that does not fit the rest of the address. - """ - CONFIRMATION_LEVEL_UNSPECIFIED = 0 - CONFIRMED = 1 - UNCONFIRMED_BUT_PLAUSIBLE = 2 - UNCONFIRMED_AND_SUSPICIOUS = 3 - - component_name: 'ComponentName' = proto.Field( - proto.MESSAGE, - number=1, - message='ComponentName', - ) - component_type: str = proto.Field( - proto.STRING, - number=2, - ) - confirmation_level: ConfirmationLevel = proto.Field( - proto.ENUM, - number=3, - enum=ConfirmationLevel, - ) - inferred: bool = proto.Field( - proto.BOOL, - number=4, - ) - spell_corrected: bool = proto.Field( - proto.BOOL, - number=5, - ) - replaced: bool = proto.Field( - proto.BOOL, - number=6, - ) - unexpected: bool = proto.Field( - proto.BOOL, - number=7, - ) - - -class ComponentName(proto.Message): - r"""A wrapper for the name of the component. - - Attributes: - text (str): - The name text. For example, "5th Avenue" for - a street name or "1253" for a street number. - language_code (str): - The BCP-47 language code. This will not be - present if the component name is not associated - with a language, such as a street number. - """ - - text: str = proto.Field( - proto.STRING, - number=1, - ) - language_code: str = proto.Field( - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py deleted file mode 100644 index fa17505ce88d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/address_validation_service.py +++ /dev/null @@ -1,413 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.maps.addressvalidation_v1.types import address as gma_address -from google.maps.addressvalidation_v1.types import geocode as gma_geocode -from google.maps.addressvalidation_v1.types import metadata_ -from google.maps.addressvalidation_v1.types import usps_data as gma_usps_data -from google.type import postal_address_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.maps.addressvalidation.v1', - manifest={ - 'ValidateAddressRequest', - 'ValidateAddressResponse', - 'ProvideValidationFeedbackRequest', - 'ProvideValidationFeedbackResponse', - 'ValidationResult', - 'Verdict', - }, -) - - -class ValidateAddressRequest(proto.Message): - r"""The request for validating an address. - - Attributes: - address (google.type.postal_address_pb2.PostalAddress): - Required. The address being validated. Unformatted addresses - should be submitted via - [``address_lines``][google.type.PostalAddress.address_lines]. - - The total length of the fields in this input must not exceed - 280 characters. - - Supported regions can be found - `here `__. - - The [language_code][google.type.PostalAddress.language_code] - value in the input address is reserved for future uses and - is ignored today. The validated address result will be - populated based on the preferred language for the given - address, as identified by the system. - - The Address Validation API ignores the values in - [recipients][google.type.PostalAddress.recipients] and - [organization][google.type.PostalAddress.organization]. Any - values in those fields will be discarded and not returned. - Please do not set them. - previous_response_id (str): - This field must be empty for the first address validation - request. If more requests are necessary to fully validate a - single address (for example if the changes the user makes - after the initial validation need to be re-validated), then - each followup request must populate this field with the - [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id] - from the very first response in the validation sequence. - enable_usps_cass (bool): - Enables USPS CASS compatible mode. This affects *only* the - [google.maps.addressvalidation.v1.ValidationResult.usps_data] - field of - [google.maps.addressvalidation.v1.ValidationResult]. Note: - for USPS CASS enabled requests for addresses in Puerto Rico, - a [google.type.PostalAddress.region_code] of the ``address`` - must be provided as "PR", or an - [google.type.PostalAddress.administrative_area] of the - ``address`` must be provided as "Puerto Rico" - (case-insensitive) or "PR". - - It's recommended to use a componentized ``address``, or - alternatively specify at least two - [google.type.PostalAddress.address_lines] where the first - line contains the street number and name and the second line - contains the city, state, and zip code. - session_token (str): - Optional. A string which identifies an Autocomplete session - for billing purposes. Must be a URL and filename safe base64 - string with at most 36 ASCII characters in length. Otherwise - an INVALID_ARGUMENT error is returned. - - The session begins when the user starts typing a query, and - concludes when they select a place and a call to Place - Details or Address Validation is made. Each session can have - multiple autocomplete queries, followed by one Place Details - or Address Validation request. The credentials used for each - request within a session must belong to the same Google - Cloud Console project. Once a session has concluded, the - token is no longer valid; your app must generate a fresh - token for each session. If the ``session_token`` parameter - is omitted, or if you reuse a session token, the session is - charged as if no session token was provided (each request is - billed separately). - - Note: Address Validation can only be used in sessions with - the Autocomplete (New) API, not the old Autocomplete API. - See - https://developers.google.com/maps/documentation/places/web-service/session-pricing - for more details. - """ - - address: postal_address_pb2.PostalAddress = proto.Field( - proto.MESSAGE, - number=1, - message=postal_address_pb2.PostalAddress, - ) - previous_response_id: str = proto.Field( - proto.STRING, - number=2, - ) - enable_usps_cass: bool = proto.Field( - proto.BOOL, - number=3, - ) - session_token: str = proto.Field( - proto.STRING, - number=5, - ) - - -class ValidateAddressResponse(proto.Message): - r"""The response to an address validation request. - - Attributes: - result (google.maps.addressvalidation_v1.types.ValidationResult): - The result of the address validation. - response_id (str): - The UUID that identifies this response. If the address needs - to be re-validated, this UUID *must* accompany the new - request. - """ - - result: 'ValidationResult' = proto.Field( - proto.MESSAGE, - number=1, - message='ValidationResult', - ) - response_id: str = proto.Field( - proto.STRING, - number=2, - ) - - -class ProvideValidationFeedbackRequest(proto.Message): - r"""The request for sending validation feedback. - - Attributes: - conclusion (google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest.ValidationConclusion): - Required. The outcome of the sequence of validation - attempts. - - If this field is set to - ``VALIDATION_CONCLUSION_UNSPECIFIED``, an - ``INVALID_ARGUMENT`` error will be returned. - response_id (str): - Required. The ID of the response that this feedback is for. - This should be the - [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] - from the first response in a series of address validation - attempts. - """ - class ValidationConclusion(proto.Enum): - r"""The possible final outcomes of the sequence of address - validation requests needed to validate an address. - - Values: - VALIDATION_CONCLUSION_UNSPECIFIED (0): - This value is unused. If the - ``ProvideValidationFeedbackRequest.conclusion`` field is set - to ``VALIDATION_CONCLUSION_UNSPECIFIED``, an - ``INVALID_ARGUMENT`` error will be returned. - VALIDATED_VERSION_USED (1): - The version of the address returned by the - Address Validation API was used for the - transaction. - USER_VERSION_USED (2): - The version of the address provided by the - user was used for the transaction - UNVALIDATED_VERSION_USED (3): - A version of the address that was entered - after the last validation attempt but that was - not re-validated was used for the transaction. - UNUSED (4): - The transaction was abandoned and the address - was not used. - """ - VALIDATION_CONCLUSION_UNSPECIFIED = 0 - VALIDATED_VERSION_USED = 1 - USER_VERSION_USED = 2 - UNVALIDATED_VERSION_USED = 3 - UNUSED = 4 - - conclusion: ValidationConclusion = proto.Field( - proto.ENUM, - number=1, - enum=ValidationConclusion, - ) - response_id: str = proto.Field( - proto.STRING, - number=2, - ) - - -class ProvideValidationFeedbackResponse(proto.Message): - r"""The response for validation feedback. - - The response is empty if the feedback is sent successfully. - - """ - - -class ValidationResult(proto.Message): - r"""The result of validating an address. - - Attributes: - verdict (google.maps.addressvalidation_v1.types.Verdict): - Overall verdict flags - address (google.maps.addressvalidation_v1.types.Address): - Information about the address itself as - opposed to the geocode. - geocode (google.maps.addressvalidation_v1.types.Geocode): - Information about the location and place that - the address geocoded to. - metadata (google.maps.addressvalidation_v1.types.AddressMetadata): - Other information relevant to deliverability. ``metadata`` - is not guaranteed to be fully populated for every address - sent to the Address Validation API. - usps_data (google.maps.addressvalidation_v1.types.UspsData): - Extra deliverability flags provided by USPS. Only provided - in region ``US`` and ``PR``. - """ - - verdict: 'Verdict' = proto.Field( - proto.MESSAGE, - number=1, - message='Verdict', - ) - address: gma_address.Address = proto.Field( - proto.MESSAGE, - number=2, - message=gma_address.Address, - ) - geocode: gma_geocode.Geocode = proto.Field( - proto.MESSAGE, - number=3, - message=gma_geocode.Geocode, - ) - metadata: metadata_.AddressMetadata = proto.Field( - proto.MESSAGE, - number=4, - message=metadata_.AddressMetadata, - ) - usps_data: gma_usps_data.UspsData = proto.Field( - proto.MESSAGE, - number=5, - message=gma_usps_data.UspsData, - ) - - -class Verdict(proto.Message): - r"""High level overview of the address validation result and - geocode. - - Attributes: - input_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): - The granularity of the **input** address. This is the result - of parsing the input address and does not give any - validation signals. For validation signals, refer to - ``validation_granularity`` below. - - For example, if the input address includes a specific - apartment number, then the ``input_granularity`` here will - be ``SUB_PREMISE``. If we cannot match the apartment number - in the databases or the apartment number is invalid, the - ``validation_granularity`` will likely be ``PREMISE`` or - below. - validation_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): - The granularity level that the API can fully **validate** - the address to. For example, an ``validation_granularity`` - of ``PREMISE`` indicates all address components at the level - of ``PREMISE`` or more coarse can be validated. - - Per address component validation result can be found in - [google.maps.addressvalidation.v1.Address.address_components]. - geocode_granularity (google.maps.addressvalidation_v1.types.Verdict.Granularity): - Information about the granularity of the - [``geocode``][google.maps.addressvalidation.v1.ValidationResult.geocode]. - This can be understood as the semantic meaning of how coarse - or fine the geocoded location is. - - This can differ from the ``validation_granularity`` above - occasionally. For example, our database might record the - existence of an apartment number but do not have a precise - location for the apartment within a big apartment complex. - In that case, the ``validation_granularity`` will be - ``SUB_PREMISE`` but the ``geocode_granularity`` will be - ``PREMISE``. - address_complete (bool): - The address is considered complete if there are no - unresolved tokens, no unexpected or missing address - components. See - [``missing_component_types``][google.maps.addressvalidation.v1.Address.missing_component_types], - [``unresolved_tokens``][google.maps.addressvalidation.v1.Address.unresolved_tokens] - or - [``unexpected``][google.maps.addressvalidation.v1.AddressComponent.unexpected] - fields for more details. - has_unconfirmed_components (bool): - At least one address component cannot be categorized or - validated, see - [google.maps.addressvalidation.v1.Address.address_components] - for details. - has_inferred_components (bool): - At least one address component was inferred (added) that - wasn't in the input, see - [google.maps.addressvalidation.v1.Address.address_components] - for details. - has_replaced_components (bool): - At least one address component was replaced, see - [google.maps.addressvalidation.v1.Address.address_components] - for details. - """ - class Granularity(proto.Enum): - r"""The various granularities that an address or a geocode can have. - When used to indicate granularity for an *address*, these values - indicate with how fine a granularity the address identifies a - mailing destination. For example, an address such as "123 Main - Street, Redwood City, CA, 94061" identifies a ``PREMISE`` while - something like "Redwood City, CA, 94061" identifies a ``LOCALITY``. - However, if we are unable to find a geocode for "123 Main Street" in - Redwood City, the geocode returned might be of ``LOCALITY`` - granularity even though the address is more granular. - - Values: - GRANULARITY_UNSPECIFIED (0): - Default value. This value is unused. - SUB_PREMISE (1): - Below-building level result, such as an - apartment. - PREMISE (2): - Building-level result. - PREMISE_PROXIMITY (3): - A geocode that approximates the - building-level location of the address. - BLOCK (4): - The address or geocode indicates a block. - Only used in regions which have block-level - addressing, such as Japan. - ROUTE (5): - The geocode or address is granular to route, - such as a street, road, or highway. - OTHER (6): - All other granularities, which are bucketed - together since they are not deliverable. - """ - GRANULARITY_UNSPECIFIED = 0 - SUB_PREMISE = 1 - PREMISE = 2 - PREMISE_PROXIMITY = 3 - BLOCK = 4 - ROUTE = 5 - OTHER = 6 - - input_granularity: Granularity = proto.Field( - proto.ENUM, - number=1, - enum=Granularity, - ) - validation_granularity: Granularity = proto.Field( - proto.ENUM, - number=2, - enum=Granularity, - ) - geocode_granularity: Granularity = proto.Field( - proto.ENUM, - number=3, - enum=Granularity, - ) - address_complete: bool = proto.Field( - proto.BOOL, - number=4, - ) - has_unconfirmed_components: bool = proto.Field( - proto.BOOL, - number=5, - ) - has_inferred_components: bool = proto.Field( - proto.BOOL, - number=6, - ) - has_replaced_components: bool = proto.Field( - proto.BOOL, - number=7, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py deleted file mode 100644 index 10af4ddb590e..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/geocode.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - -from google.geo.type.types import viewport -from google.type import latlng_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.maps.addressvalidation.v1', - manifest={ - 'Geocode', - 'PlusCode', - }, -) - - -class Geocode(proto.Message): - r"""Contains information about the place the input was geocoded - to. - - Attributes: - location (google.type.latlng_pb2.LatLng): - The geocoded location of the input. - - Using place IDs is preferred over using - addresses, latitude/longitude coordinates, or - plus codes. Using coordinates when routing or - calculating driving directions will always - result in the point being snapped to the road - nearest to those coordinates. This may not be a - road that will quickly or safely lead to the - destination and may not be near an access point - to the property. Additionally, when a location - is reverse geocoded, there is no guarantee that - the returned address will match the original. - plus_code (google.maps.addressvalidation_v1.types.PlusCode): - The plus code corresponding to the ``location``. - bounds (google.geo.type.types.Viewport): - The bounds of the geocoded place. - feature_size_meters (float): - The size of the geocoded place, in meters. - This is another measure of the coarseness of the - geocoded location, but in physical size rather - than in semantic meaning. - place_id (str): - The PlaceID of the place this input geocodes to. - - For more information about Place IDs see - `here `__. - place_types (MutableSequence[str]): - The type(s) of place that the input geocoded to. For - example, ``['locality', 'political']``. The full list of - types can be found - `here `__. - """ - - location: latlng_pb2.LatLng = proto.Field( - proto.MESSAGE, - number=1, - message=latlng_pb2.LatLng, - ) - plus_code: 'PlusCode' = proto.Field( - proto.MESSAGE, - number=2, - message='PlusCode', - ) - bounds: viewport.Viewport = proto.Field( - proto.MESSAGE, - number=4, - message=viewport.Viewport, - ) - feature_size_meters: float = proto.Field( - proto.FLOAT, - number=5, - ) - place_id: str = proto.Field( - proto.STRING, - number=6, - ) - place_types: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=7, - ) - - -class PlusCode(proto.Message): - r"""Plus code (http://plus.codes) is a location reference with - two formats: global code defining a 14mx14m (1/8000th of a - degree) or smaller rectangle, and compound code, replacing the - prefix with a reference location. - - Attributes: - global_code (str): - Place's global (full) code, such as - "9FWM33GV+HQ", representing an 1/8000 by 1/8000 - degree area (~14 by 14 meters). - compound_code (str): - Place's compound code, such as "33GV+HQ, - Ramberg, Norway", containing the suffix of the - global code and replacing the prefix with a - formatted name of a reference entity. - """ - - global_code: str = proto.Field( - proto.STRING, - number=1, - ) - compound_code: str = proto.Field( - proto.STRING, - number=2, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py deleted file mode 100644 index 08e6d46d4509..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/metadata_.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.maps.addressvalidation.v1', - manifest={ - 'AddressMetadata', - }, -) - - -class AddressMetadata(proto.Message): - r"""The metadata for the address. ``metadata`` is not guaranteed to be - fully populated for every address sent to the Address Validation - API. - - - .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields - - Attributes: - business (bool): - Indicates that this is the address of a - business. If unset, indicates that the value is - unknown. - - This field is a member of `oneof`_ ``_business``. - po_box (bool): - Indicates that the address of a PO box. - If unset, indicates that the value is unknown. - - This field is a member of `oneof`_ ``_po_box``. - residential (bool): - Indicates that this is the address of a - residence. If unset, indicates that the value is - unknown. - - This field is a member of `oneof`_ ``_residential``. - """ - - business: bool = proto.Field( - proto.BOOL, - number=2, - optional=True, - ) - po_box: bool = proto.Field( - proto.BOOL, - number=3, - optional=True, - ) - residential: bool = proto.Field( - proto.BOOL, - number=6, - optional=True, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py b/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py deleted file mode 100644 index af81676ea2aa..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/google/maps/addressvalidation_v1/types/usps_data.py +++ /dev/null @@ -1,493 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -from __future__ import annotations - -from typing import MutableMapping, MutableSequence - -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.maps.addressvalidation.v1', - manifest={ - 'UspsAddress', - 'UspsData', - }, -) - - -class UspsAddress(proto.Message): - r"""USPS representation of a US address. - - Attributes: - first_address_line (str): - First address line. - firm (str): - Firm name. - second_address_line (str): - Second address line. - urbanization (str): - Puerto Rican urbanization name. - city_state_zip_address_line (str): - City + state + postal code. - city (str): - City name. - state (str): - 2 letter state code. - zip_code (str): - Postal code e.g. 10009. - zip_code_extension (str): - 4-digit postal code extension e.g. 5023. - """ - - first_address_line: str = proto.Field( - proto.STRING, - number=1, - ) - firm: str = proto.Field( - proto.STRING, - number=2, - ) - second_address_line: str = proto.Field( - proto.STRING, - number=3, - ) - urbanization: str = proto.Field( - proto.STRING, - number=4, - ) - city_state_zip_address_line: str = proto.Field( - proto.STRING, - number=5, - ) - city: str = proto.Field( - proto.STRING, - number=6, - ) - state: str = proto.Field( - proto.STRING, - number=7, - ) - zip_code: str = proto.Field( - proto.STRING, - number=8, - ) - zip_code_extension: str = proto.Field( - proto.STRING, - number=9, - ) - - -class UspsData(proto.Message): - r"""The USPS data for the address. ``uspsData`` is not guaranteed to be - fully populated for every US or PR address sent to the Address - Validation API. It's recommended to integrate the backup address - fields in the response if you utilize uspsData as the primary part - of the response. - - Attributes: - standardized_address (google.maps.addressvalidation_v1.types.UspsAddress): - USPS standardized address. - delivery_point_code (str): - 2 digit delivery point code - delivery_point_check_digit (str): - The delivery point check digit. This number is added to the - end of the delivery_point_barcode for mechanically scanned - mail. Adding all the digits of the delivery_point_barcode, - delivery_point_check_digit, postal code, and ZIP+4 together - should yield a number divisible by 10. - dpv_confirmation (str): - The possible values for DPV confirmation. Returns a single - character or returns no value. - - - ``N``: Primary and any secondary number information - failed to DPV confirm. - - ``D``: Address was DPV confirmed for the primary number - only, and the secondary number information was missing. - - ``S``: Address was DPV confirmed for the primary number - only, and the secondary number information was present - but not confirmed. - - ``Y``: Address was DPV confirmed for primary and any - secondary numbers. - - Empty: If the response does not contain a - ``dpv_confirmation`` value, the address was not submitted - for DPV confirmation. - dpv_footnote (str): - The footnotes from delivery point validation. Multiple - footnotes may be strung together in the same string. - - - ``AA``: Input address matched to the ZIP+4 file - - ``A1``: Input address was not matched to the ZIP+4 file - - ``BB``: Matched to DPV (all components) - - ``CC``: Secondary number not matched and not required - - ``C1``: Secondary number not matched but required - - ``N1``: High-rise address missing secondary number - - ``M1``: Primary number missing - - ``M3``: Primary number invalid - - ``P1``: Input address PO, RR or HC box number missing - - ``P3``: Input address PO, RR, or HC Box number invalid - - ``F1``: Input address matched to a military address - - ``G1``: Input address matched to a general delivery - address - - ``U1``: Input address matched to a unique ZIP code - - ``PB``: Input address matched to PBSA record - - ``RR``: DPV confirmed address with PMB information - - ``R1``: DPV confirmed address without PMB information - - ``R7``: Carrier Route R777 or R779 record - - ``IA``: Informed Address identified - - ``TA``: Primary number matched by dropping a trailing - alpha - dpv_cmra (str): - Indicates if the address is a CMRA (Commercial Mail - Receiving Agency)--a private business receiving mail for - clients. Returns a single character. - - - ``Y``: The address is a CMRA - - ``N``: The address is not a CMRA - dpv_vacant (str): - Is this place vacant? Returns a single character. - - - ``Y``: The address is vacant - - ``N``: The address is not vacant - dpv_no_stat (str): - Is this a no stat address or an active address? No stat - addresses are ones which are not continuously occupied or - addresses that the USPS does not service. Returns a single - character. - - - ``Y``: The address is not active - - ``N``: The address is active - dpv_no_stat_reason_code (int): - Indicates the NoStat type. Returns a reason code as int. - - - ``1``: IDA (Internal Drop Address) – Addresses that do - not receive mail directly from the USPS but are delivered - to a drop address that services them. - - ``2``: CDS - Addresses that have not yet become - deliverable. For example, a new subdivision where lots - and primary numbers have been determined, but no - structure exists yet for occupancy. - - ``3``: Collision - Addresses that do not actually DPV - confirm. - - ``4``: CMZ (College, Military and Other Types) - ZIP + 4 - records USPS has incorporated into the data. - - ``5``: Regular - Indicates addresses not receiving - delivery and the addresses are not counted as possible - deliveries. - - ``6``: Secondary Required - The address requires - secondary information. - dpv_drop (str): - Flag indicates mail is delivered to a single receptable at a - site. Returns a single character. - - - ``Y``: The mail is delivered to a single receptable at a - site. - - ``N``: The mail is not delivered to a single receptable - at a site. - dpv_throwback (str): - Indicates that mail is not delivered to the street address. - Returns a single character. - - - ``Y``: The mail is not delivered to the street address. - - ``N``: The mail is delivered to the street address. - dpv_non_delivery_days (str): - Flag indicates mail delivery is not performed every day of - the week. Returns a single character. - - - ``Y``: The mail delivery is not performed every day of - the week. - - ``N``: No indication the mail delivery is not performed - every day of the week. - dpv_non_delivery_days_values (int): - Integer identifying non-delivery days. It can - be interrogated using bit flags: - - 0x40 – Sunday is a non-delivery day - 0x20 – Monday is a non-delivery day - 0x10 – Tuesday is a non-delivery day - 0x08 – Wednesday is a non-delivery day - 0x04 – Thursday is a non-delivery day - 0x02 – Friday is a non-delivery day - 0x01 – Saturday is a non-delivery day - dpv_no_secure_location (str): - Flag indicates door is accessible, but package will not be - left due to security concerns. Returns a single character. - - - ``Y``: The package will not be left due to security - concerns. - - ``N``: No indication the package will not be left due to - security concerns. - dpv_pbsa (str): - Indicates the address was matched to PBSA record. Returns a - single character. - - - ``Y``: The address was matched to PBSA record. - - ``N``: The address was not matched to PBSA record. - dpv_door_not_accessible (str): - Flag indicates addresses where USPS cannot knock on a door - to deliver mail. Returns a single character. - - - ``Y``: The door is not accessible. - - ``N``: No indication the door is not accessible. - dpv_enhanced_delivery_code (str): - Indicates that more than one DPV return code is valid for - the address. Returns a single character. - - - ``Y``: Address was DPV confirmed for primary and any - secondary numbers. - - ``N``: Primary and any secondary number information - failed to DPV confirm. - - ``S``: Address was DPV confirmed for the primary number - only, and the secondary number information was present by - not confirmed, or a single trailing alpha on a primary - number was dropped to make a DPV match and secondary - information required. - - ``D``: Address was DPV confirmed for the primary number - only, and the secondary number information was missing. - - ``R``: Address confirmed but assigned to phantom route - R777 and R779 and USPS delivery is not provided. - carrier_route (str): - The carrier route code. A four character code consisting of - a one letter prefix and a three digit route designator. - - Prefixes: - - - ``C``: Carrier route (or city route) - - ``R``: Rural route - - ``H``: Highway Contract Route - - ``B``: Post Office Box Section - - ``G``: General delivery unit - carrier_route_indicator (str): - Carrier route rate sort indicator. - ews_no_match (bool): - The delivery address is matchable, but the - EWS file indicates that an exact match will be - available soon. - post_office_city (str): - Main post office city. - post_office_state (str): - Main post office state. - abbreviated_city (str): - Abbreviated city. - fips_county_code (str): - FIPS county code. - county (str): - County name. - elot_number (str): - Enhanced Line of Travel (eLOT) number. - elot_flag (str): - eLOT Ascending/Descending Flag (A/D). - lacs_link_return_code (str): - LACSLink return code. - lacs_link_indicator (str): - LACSLink indicator. - po_box_only_postal_code (bool): - PO Box only postal code. - suitelink_footnote (str): - Footnotes from matching a street or highrise record to suite - information. If business name match is found, the secondary - number is returned. - - - ``A``: SuiteLink record match, business address improved. - - ``00``: No match, business address is not improved. - pmb_designator (str): - PMB (Private Mail Box) unit designator. - pmb_number (str): - PMB (Private Mail Box) number; - address_record_type (str): - Type of the address record that matches the input address. - - - ``F``: FIRM. This is a match to a Firm Record, which is - the finest level of match available for an address. - - ``G``: GENERAL DELIVERY. This is a match to a General - Delivery record. - - ``H``: BUILDING / APARTMENT. This is a match to a - Building or Apartment record. - - ``P``: POST OFFICE BOX. This is a match to a Post Office - Box. - - ``R``: RURAL ROUTE or HIGHWAY CONTRACT: This is a match - to either a Rural Route or a Highway Contract record, - both of which may have associated Box Number ranges. - - ``S``: STREET RECORD: This is a match to a Street record - containing a valid primary number range. - default_address (bool): - Indicator that a default address was found, - but more specific addresses exists. - error_message (str): - Error message for USPS data retrieval. This - is populated when USPS processing is suspended - because of the detection of artificially created - addresses. - - The USPS data fields might not be populated when - this error is present. - cass_processed (bool): - Indicator that the request has been CASS - processed. - """ - - standardized_address: 'UspsAddress' = proto.Field( - proto.MESSAGE, - number=1, - message='UspsAddress', - ) - delivery_point_code: str = proto.Field( - proto.STRING, - number=2, - ) - delivery_point_check_digit: str = proto.Field( - proto.STRING, - number=3, - ) - dpv_confirmation: str = proto.Field( - proto.STRING, - number=4, - ) - dpv_footnote: str = proto.Field( - proto.STRING, - number=5, - ) - dpv_cmra: str = proto.Field( - proto.STRING, - number=6, - ) - dpv_vacant: str = proto.Field( - proto.STRING, - number=7, - ) - dpv_no_stat: str = proto.Field( - proto.STRING, - number=8, - ) - dpv_no_stat_reason_code: int = proto.Field( - proto.INT32, - number=29, - ) - dpv_drop: str = proto.Field( - proto.STRING, - number=30, - ) - dpv_throwback: str = proto.Field( - proto.STRING, - number=31, - ) - dpv_non_delivery_days: str = proto.Field( - proto.STRING, - number=32, - ) - dpv_non_delivery_days_values: int = proto.Field( - proto.INT32, - number=33, - ) - dpv_no_secure_location: str = proto.Field( - proto.STRING, - number=34, - ) - dpv_pbsa: str = proto.Field( - proto.STRING, - number=35, - ) - dpv_door_not_accessible: str = proto.Field( - proto.STRING, - number=36, - ) - dpv_enhanced_delivery_code: str = proto.Field( - proto.STRING, - number=37, - ) - carrier_route: str = proto.Field( - proto.STRING, - number=9, - ) - carrier_route_indicator: str = proto.Field( - proto.STRING, - number=10, - ) - ews_no_match: bool = proto.Field( - proto.BOOL, - number=11, - ) - post_office_city: str = proto.Field( - proto.STRING, - number=12, - ) - post_office_state: str = proto.Field( - proto.STRING, - number=13, - ) - abbreviated_city: str = proto.Field( - proto.STRING, - number=14, - ) - fips_county_code: str = proto.Field( - proto.STRING, - number=15, - ) - county: str = proto.Field( - proto.STRING, - number=16, - ) - elot_number: str = proto.Field( - proto.STRING, - number=17, - ) - elot_flag: str = proto.Field( - proto.STRING, - number=18, - ) - lacs_link_return_code: str = proto.Field( - proto.STRING, - number=19, - ) - lacs_link_indicator: str = proto.Field( - proto.STRING, - number=20, - ) - po_box_only_postal_code: bool = proto.Field( - proto.BOOL, - number=21, - ) - suitelink_footnote: str = proto.Field( - proto.STRING, - number=22, - ) - pmb_designator: str = proto.Field( - proto.STRING, - number=23, - ) - pmb_number: str = proto.Field( - proto.STRING, - number=24, - ) - address_record_type: str = proto.Field( - proto.STRING, - number=25, - ) - default_address: bool = proto.Field( - proto.BOOL, - number=26, - ) - error_message: str = proto.Field( - proto.STRING, - number=27, - ) - cass_processed: bool = proto.Field( - proto.BOOL, - number=28, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini b/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py b/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py deleted file mode 100644 index 43670ad6bbba..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/noxfile.py +++ /dev/null @@ -1,253 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -import pathlib -import re -import shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", - "3.12" -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = 'google-maps-addressvalidation' - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.12" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "prerelease_deps", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/maps/addressvalidation_v1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - -@nox.session(python=ALL_PYTHON[-1]) -def prerelease_deps(session): - """Run the unit test suite against pre-release versions of dependencies.""" - - # Install test environment dependencies - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - - # Install the package without dependencies - session.install('-e', '.', '--no-deps') - - # We test the minimum dependency versions using the minimum Python - # version so the lowest python runtime that we test has a corresponding constraints - # file, located at `testing/constraints--.txt`, which contains all of the - # dependencies and extras. - with open( - CURRENT_DIRECTORY - / "testing" - / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - session.install(*constraints_deps) - - prerel_deps = [ - "googleapis-common-protos", - "google-api-core", - "google-auth", - "grpcio", - "grpcio-status", - "protobuf", - "proto-plus", - ] - - for dep in prerel_deps: - session.install("--pre", "--no-deps", "--upgrade", dep) - - # Remaining dependencies - other_deps = [ - "requests", - ] - session.install(*other_deps) - - # Print out prerelease package versions - - session.run("python", "-c", "import google.api_core; print(google.api_core.__version__)") - session.run("python", "-c", "import google.auth; print(google.auth.__version__)") - session.run("python", "-c", "import grpc; print(grpc.__version__)") - session.run( - "python", "-c", "import google.protobuf; print(google.protobuf.__version__)" - ) - session.run( - "python", "-c", "import proto; print(proto.__version__)" - ) - - session.run( - 'py.test', - '--quiet', - '--cov=google/maps/addressvalidation_v1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - session.install('.') - session.run( - 'mypy', - '-p', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==7.0.1", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py deleted file mode 100644 index 7274018b4b0b..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ProvideValidationFeedback -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-maps-addressvalidation - - -# [START addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.maps import addressvalidation_v1 - - -async def sample_provide_validation_feedback(): - # Create a client - client = addressvalidation_v1.AddressValidationAsyncClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ProvideValidationFeedbackRequest( - conclusion="UNUSED", - response_id="response_id_value", - ) - - # Make the request - response = await client.provide_validation_feedback(request=request) - - # Handle the response - print(response) - -# [END addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py deleted file mode 100644 index c304e0e7b77e..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ProvideValidationFeedback -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-maps-addressvalidation - - -# [START addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.maps import addressvalidation_v1 - - -def sample_provide_validation_feedback(): - # Create a client - client = addressvalidation_v1.AddressValidationClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ProvideValidationFeedbackRequest( - conclusion="UNUSED", - response_id="response_id_value", - ) - - # Make the request - response = client.provide_validation_feedback(request=request) - - # Handle the response - print(response) - -# [END addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py deleted file mode 100644 index c256fc8b091f..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ValidateAddress -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-maps-addressvalidation - - -# [START addressvalidation_v1_generated_AddressValidation_ValidateAddress_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.maps import addressvalidation_v1 - - -async def sample_validate_address(): - # Create a client - client = addressvalidation_v1.AddressValidationAsyncClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ValidateAddressRequest( - ) - - # Make the request - response = await client.validate_address(request=request) - - # Handle the response - print(response) - -# [END addressvalidation_v1_generated_AddressValidation_ValidateAddress_async] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py deleted file mode 100644 index 38316149c05d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/addressvalidation_v1_generated_address_validation_validate_address_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ValidateAddress -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-maps-addressvalidation - - -# [START addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.maps import addressvalidation_v1 - - -def sample_validate_address(): - # Create a client - client = addressvalidation_v1.AddressValidationClient() - - # Initialize request argument(s) - request = addressvalidation_v1.ValidateAddressRequest( - ) - - # Make the request - response = client.validate_address(request=request) - - # Handle the response - print(response) - -# [END addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync] diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json b/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json deleted file mode 100644 index b8aeda3afd23..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/samples/generated_samples/snippet_metadata_google.maps.addressvalidation.v1.json +++ /dev/null @@ -1,321 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.maps.addressvalidation.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-maps-addressvalidation", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient", - "shortName": "AddressValidationAsyncClient" - }, - "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient.provide_validation_feedback", - "method": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback", - "service": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation", - "shortName": "AddressValidation" - }, - "shortName": "ProvideValidationFeedback" - }, - "parameters": [ - { - "name": "request", - "type": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse", - "shortName": "provide_validation_feedback" - }, - "description": "Sample for ProvideValidationFeedback", - "file": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.maps.addressvalidation_v1.AddressValidationClient", - "shortName": "AddressValidationClient" - }, - "fullName": "google.maps.addressvalidation_v1.AddressValidationClient.provide_validation_feedback", - "method": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation.ProvideValidationFeedback", - "service": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation", - "shortName": "AddressValidation" - }, - "shortName": "ProvideValidationFeedback" - }, - "parameters": [ - { - "name": "request", - "type": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.maps.addressvalidation_v1.types.ProvideValidationFeedbackResponse", - "shortName": "provide_validation_feedback" - }, - "description": "Sample for ProvideValidationFeedback", - "file": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "addressvalidation_v1_generated_AddressValidation_ProvideValidationFeedback_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "addressvalidation_v1_generated_address_validation_provide_validation_feedback_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient", - "shortName": "AddressValidationAsyncClient" - }, - "fullName": "google.maps.addressvalidation_v1.AddressValidationAsyncClient.validate_address", - "method": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress", - "service": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation", - "shortName": "AddressValidation" - }, - "shortName": "ValidateAddress" - }, - "parameters": [ - { - "name": "request", - "type": "google.maps.addressvalidation_v1.types.ValidateAddressRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.maps.addressvalidation_v1.types.ValidateAddressResponse", - "shortName": "validate_address" - }, - "description": "Sample for ValidateAddress", - "file": "addressvalidation_v1_generated_address_validation_validate_address_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "addressvalidation_v1_generated_AddressValidation_ValidateAddress_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "addressvalidation_v1_generated_address_validation_validate_address_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.maps.addressvalidation_v1.AddressValidationClient", - "shortName": "AddressValidationClient" - }, - "fullName": "google.maps.addressvalidation_v1.AddressValidationClient.validate_address", - "method": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation.ValidateAddress", - "service": { - "fullName": "google.maps.addressvalidation.v1.AddressValidation", - "shortName": "AddressValidation" - }, - "shortName": "ValidateAddress" - }, - "parameters": [ - { - "name": "request", - "type": "google.maps.addressvalidation_v1.types.ValidateAddressRequest" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.maps.addressvalidation_v1.types.ValidateAddressResponse", - "shortName": "validate_address" - }, - "description": "Sample for ValidateAddress", - "file": "addressvalidation_v1_generated_address_validation_validate_address_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "addressvalidation_v1_generated_AddressValidation_ValidateAddress_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "addressvalidation_v1_generated_address_validation_validate_address_sync.py" - } - ] -} diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py b/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py deleted file mode 100644 index 07ecb8b60bc3..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/scripts/fixup_addressvalidation_v1_keywords.py +++ /dev/null @@ -1,177 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class addressvalidationCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'provide_validation_feedback': ('conclusion', 'response_id', ), - 'validate_address': ('address', 'previous_response_id', 'enable_usps_cass', 'session_token', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: a.keyword.value not in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=addressvalidationCallTransformer(), -): - """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 addressvalidation client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/setup.py b/owl-bot-staging/google-maps-addressvalidation/v1/setup.py deleted file mode 100644 index 474386e7f2d3..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/setup.py +++ /dev/null @@ -1,92 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import io -import os -import re - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-maps-addressvalidation' - - -description = "Google Maps Addressvalidation API client library" - -version = None - -with open(os.path.join(package_root, 'google/maps/addressvalidation/gapic_version.py')) as fp: - version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) - assert (len(version_candidates) == 1) - version = version_candidates[0] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "google-auth >= 2.14.1, <3.0.0dev", - "proto-plus >= 1.22.3, <2.0.0dev", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", - "google-geo-type >= 0.1.0, <1.0.0dev", -] -url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-addressvalidation" - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, "README.rst") -with io.open(readme_filename, encoding="utf-8") as readme_file: - readme = readme_file.read() - -packages = [ - package - for package in setuptools.find_namespace_packages() - if package.startswith("google") -] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt deleted file mode 100644 index 2214a366a259..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.10.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt deleted file mode 100644 index 2214a366a259..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.11.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt deleted file mode 100644 index 2214a366a259..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.12.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt deleted file mode 100644 index 66fa4554264e..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,11 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.1 -google-auth==2.14.1 -proto-plus==1.22.3 -protobuf==3.19.5 -google-geo-type==0.1.0 diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt deleted file mode 100644 index 2214a366a259..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.8.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt deleted file mode 100644 index 2214a366a259..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/testing/constraints-3.9.txt +++ /dev/null @@ -1,7 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf -google-geo-type diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py deleted file mode 100644 index 1b4db446eb8d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py deleted file mode 100644 index 1b4db446eb8d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 1b4db446eb8d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py deleted file mode 100644 index 1b4db446eb8d..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py b/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py deleted file mode 100644 index abf323af2222..000000000000 --- a/owl-bot-staging/google-maps-addressvalidation/v1/tests/unit/gapic/addressvalidation_v1/test_address_validation.py +++ /dev/null @@ -1,1944 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2023 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -import os -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from google.api_core import api_core_version -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.maps.addressvalidation_v1.services.address_validation import AddressValidationAsyncClient -from google.maps.addressvalidation_v1.services.address_validation import AddressValidationClient -from google.maps.addressvalidation_v1.services.address_validation import transports -from google.maps.addressvalidation_v1.types import address_validation_service -from google.oauth2 import service_account -from google.type import postal_address_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - -# If default endpoint template is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint template so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint_template(client): - return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert AddressValidationClient._get_default_mtls_endpoint(None) is None - assert AddressValidationClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert AddressValidationClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert AddressValidationClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert AddressValidationClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert AddressValidationClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - -def test__read_environment_variables(): - assert AddressValidationClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - assert AddressValidationClient._read_environment_variables() == (True, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - assert AddressValidationClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - AddressValidationClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - assert AddressValidationClient._read_environment_variables() == (False, "never", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - assert AddressValidationClient._read_environment_variables() == (False, "always", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): - assert AddressValidationClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - AddressValidationClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): - assert AddressValidationClient._read_environment_variables() == (False, "auto", "foo.com") - -def test__get_client_cert_source(): - mock_provided_cert_source = mock.Mock() - mock_default_cert_source = mock.Mock() - - assert AddressValidationClient._get_client_cert_source(None, False) is None - assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, False) is None - assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source - - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_default_cert_source): - assert AddressValidationClient._get_client_cert_source(None, True) is mock_default_cert_source - assert AddressValidationClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source - -@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) -@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) -def test__get_api_endpoint(): - api_override = "foo.com" - mock_client_cert_source = mock.Mock() - default_universe = AddressValidationClient._DEFAULT_UNIVERSE - default_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - assert AddressValidationClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override - assert AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT - assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint - assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "always") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT - assert AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == AddressValidationClient.DEFAULT_MTLS_ENDPOINT - assert AddressValidationClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint - assert AddressValidationClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint - - with pytest.raises(MutualTLSChannelError) as excinfo: - AddressValidationClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") - assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." - -def test__get_universe_domain(): - client_universe_domain = "foo.com" - universe_domain_env = "bar.com" - - assert AddressValidationClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain - assert AddressValidationClient._get_universe_domain(None, universe_domain_env) == universe_domain_env - assert AddressValidationClient._get_universe_domain(None, None) == AddressValidationClient._DEFAULT_UNIVERSE - - with pytest.raises(ValueError) as excinfo: - AddressValidationClient._get_universe_domain("", None) - assert str(excinfo.value) == "Universe Domain cannot be an empty string." - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), -]) -def test__validate_universe_domain(client_class, transport_class, transport_name): - client = client_class( - transport=transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - ) - assert client._validate_universe_domain() == True - - # Test the case when universe is already validated. - assert client._validate_universe_domain() == True - - if transport_name == "grpc": - # Test the case where credentials are provided by the - # `local_channel_credentials`. The default universes in both match. - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - client = client_class(transport=transport_class(channel=channel)) - assert client._validate_universe_domain() == True - - # Test the case where credentials do not exist: e.g. a transport is provided - # with no credentials. Validation should still succeed because there is no - # mismatch with non-existent credentials. - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - transport=transport_class(channel=channel) - transport._credentials = None - client = client_class(transport=transport) - assert client._validate_universe_domain() == True - - # TODO: This is needed to cater for older versions of google-auth - # Make this test unconditional once the minimum supported version of - # google-auth becomes 2.23.0 or higher. - google_auth_major, google_auth_minor = [int(part) for part in google.auth.__version__.split(".")[0:2]] - if google_auth_major > 2 or (google_auth_major == 2 and google_auth_minor >= 23): - credentials = ga_credentials.AnonymousCredentials() - credentials._universe_domain = "foo.com" - # Test the case when there is a universe mismatch from the credentials. - client = client_class( - transport=transport_class(credentials=credentials) - ) - with pytest.raises(ValueError) as excinfo: - client._validate_universe_domain() - assert str(excinfo.value) == "The configured universe domain (googleapis.com) does not match the universe domain found in the credentials (foo.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." - - # Test the case when there is a universe mismatch from the client. - # - # TODO: Make this test unconditional once the minimum supported version of - # google-api-core becomes 2.15.0 or higher. - api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]] - if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 15): - client = client_class(client_options={"universe_domain": "bar.com"}, transport=transport_class(credentials=ga_credentials.AnonymousCredentials(),)) - with pytest.raises(ValueError) as excinfo: - client._validate_universe_domain() - assert str(excinfo.value) == "The configured universe domain (bar.com) does not match the universe domain found in the credentials (googleapis.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." - - # Test that ValueError is raised if universe_domain is provided via client options and credentials is None - with pytest.raises(ValueError): - client._compare_universes("foo.bar", None) - - -@pytest.mark.parametrize("client_class,transport_name", [ - (AddressValidationClient, "grpc"), - (AddressValidationAsyncClient, "grpc_asyncio"), - (AddressValidationClient, "rest"), -]) -def test_address_validation_client_from_service_account_info(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'addressvalidation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://addressvalidation.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.AddressValidationGrpcTransport, "grpc"), - (transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.AddressValidationRestTransport, "rest"), -]) -def test_address_validation_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class,transport_name", [ - (AddressValidationClient, "grpc"), - (AddressValidationAsyncClient, "grpc_asyncio"), - (AddressValidationClient, "rest"), -]) -def test_address_validation_client_from_service_account_file(client_class, transport_name): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'addressvalidation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://addressvalidation.googleapis.com' - ) - - -def test_address_validation_client_get_transport_class(): - transport = AddressValidationClient.get_transport_class() - available_transports = [ - transports.AddressValidationGrpcTransport, - transports.AddressValidationRestTransport, - ] - assert transport in available_transports - - transport = AddressValidationClient.get_transport_class("grpc") - assert transport == transports.AddressValidationGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), -]) -@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) -@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) -def test_address_validation_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(AddressValidationClient, '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(AddressValidationClient, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", "true"), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", "false"), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest", "true"), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest", "false"), -]) -@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) -@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_address_validation_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class", [ - AddressValidationClient, AddressValidationAsyncClient -]) -@mock.patch.object(AddressValidationClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AddressValidationClient)) -@mock.patch.object(AddressValidationAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(AddressValidationAsyncClient)) -def test_address_validation_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - -@pytest.mark.parametrize("client_class", [ - AddressValidationClient, AddressValidationAsyncClient -]) -@mock.patch.object(AddressValidationClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationClient)) -@mock.patch.object(AddressValidationAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(AddressValidationAsyncClient)) -def test_address_validation_client_client_api_endpoint(client_class): - mock_client_cert_source = client_cert_source_callback - api_override = "foo.com" - default_universe = AddressValidationClient._DEFAULT_UNIVERSE - default_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = AddressValidationClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", - # use ClientOptions.api_endpoint as the api endpoint regardless. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == api_override - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", - # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - - # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), - # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, - # and ClientOptions.universe_domain="bar.com", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. - options = client_options.ClientOptions() - universe_exists = hasattr(options, "universe_domain") - if universe_exists: - options = client_options.ClientOptions(universe_domain=mock_universe) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - else: - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) - assert client.universe_domain == (mock_universe if universe_exists else default_universe) - - # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - options = client_options.ClientOptions() - if hasattr(options, "universe_domain"): - delattr(options, "universe_domain") - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc"), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio"), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest"), -]) -def test_address_validation_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", grpc_helpers), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (AddressValidationClient, transports.AddressValidationRestTransport, "rest", None), -]) -def test_address_validation_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - -def test_address_validation_client_client_options_from_dict(): - with mock.patch('google.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = AddressValidationClient( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport, "grpc", grpc_helpers), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_address_validation_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "addressvalidation.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( -), - scopes=None, - default_host="addressvalidation.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - address_validation_service.ValidateAddressRequest, - dict, -]) -def test_validate_address(request_type, transport: str = 'grpc'): - client = AddressValidationClient( - 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.validate_address), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = address_validation_service.ValidateAddressResponse( - response_id='response_id_value', - ) - response = client.validate_address(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ValidateAddressRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ValidateAddressResponse) - assert response.response_id == 'response_id_value' - - -def test_validate_address_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 = AddressValidationClient( - 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.validate_address), - '__call__') as call: - client.validate_address() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ValidateAddressRequest() - -@pytest.mark.asyncio -async def test_validate_address_async(transport: str = 'grpc_asyncio', request_type=address_validation_service.ValidateAddressRequest): - client = AddressValidationAsyncClient( - 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.validate_address), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(address_validation_service.ValidateAddressResponse( - response_id='response_id_value', - )) - response = await client.validate_address(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ValidateAddressRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ValidateAddressResponse) - assert response.response_id == 'response_id_value' - - -@pytest.mark.asyncio -async def test_validate_address_async_from_dict(): - await test_validate_address_async(request_type=dict) - - -@pytest.mark.parametrize("request_type", [ - address_validation_service.ProvideValidationFeedbackRequest, - dict, -]) -def test_provide_validation_feedback(request_type, transport: str = 'grpc'): - client = AddressValidationClient( - 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.provide_validation_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = address_validation_service.ProvideValidationFeedbackResponse( - ) - response = client.provide_validation_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) - - -def test_provide_validation_feedback_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 = AddressValidationClient( - 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.provide_validation_feedback), - '__call__') as call: - client.provide_validation_feedback() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() - -@pytest.mark.asyncio -async def test_provide_validation_feedback_async(transport: str = 'grpc_asyncio', request_type=address_validation_service.ProvideValidationFeedbackRequest): - client = AddressValidationAsyncClient( - 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.provide_validation_feedback), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(address_validation_service.ProvideValidationFeedbackResponse( - )) - response = await client.provide_validation_feedback(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == address_validation_service.ProvideValidationFeedbackRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) - - -@pytest.mark.asyncio -async def test_provide_validation_feedback_async_from_dict(): - await test_provide_validation_feedback_async(request_type=dict) - - -@pytest.mark.parametrize("request_type", [ - address_validation_service.ValidateAddressRequest, - dict, -]) -def test_validate_address_rest(request_type): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = address_validation_service.ValidateAddressResponse( - response_id='response_id_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = address_validation_service.ValidateAddressResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.validate_address(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ValidateAddressResponse) - assert response.response_id == 'response_id_value' - - -def test_validate_address_rest_required_fields(request_type=address_validation_service.ValidateAddressRequest): - transport_class = transports.AddressValidationRestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).validate_address._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).validate_address._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = address_validation_service.ValidateAddressResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = address_validation_service.ValidateAddressResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.validate_address(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_validate_address_rest_unset_required_fields(): - transport = transports.AddressValidationRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.validate_address._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("address", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_validate_address_rest_interceptors(null_interceptor): - transport = transports.AddressValidationRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.AddressValidationRestInterceptor(), - ) - client = AddressValidationClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.AddressValidationRestInterceptor, "post_validate_address") as post, \ - mock.patch.object(transports.AddressValidationRestInterceptor, "pre_validate_address") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = address_validation_service.ValidateAddressRequest.pb(address_validation_service.ValidateAddressRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = address_validation_service.ValidateAddressResponse.to_json(address_validation_service.ValidateAddressResponse()) - - request = address_validation_service.ValidateAddressRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = address_validation_service.ValidateAddressResponse() - - client.validate_address(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_validate_address_rest_bad_request(transport: str = 'rest', request_type=address_validation_service.ValidateAddressRequest): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.validate_address(request) - - -def test_validate_address_rest_error(): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - address_validation_service.ProvideValidationFeedbackRequest, - dict, -]) -def test_provide_validation_feedback_rest(request_type): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = address_validation_service.ProvideValidationFeedbackResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = address_validation_service.ProvideValidationFeedbackResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.provide_validation_feedback(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, address_validation_service.ProvideValidationFeedbackResponse) - - -def test_provide_validation_feedback_rest_required_fields(request_type=address_validation_service.ProvideValidationFeedbackRequest): - transport_class = transports.AddressValidationRestTransport - - request_init = {} - request_init["response_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).provide_validation_feedback._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["responseId"] = 'response_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).provide_validation_feedback._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "responseId" in jsonified_request - assert jsonified_request["responseId"] == 'response_id_value' - - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = address_validation_service.ProvideValidationFeedbackResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = address_validation_service.ProvideValidationFeedbackResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.provide_validation_feedback(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_provide_validation_feedback_rest_unset_required_fields(): - transport = transports.AddressValidationRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.provide_validation_feedback._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("conclusion", "responseId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_provide_validation_feedback_rest_interceptors(null_interceptor): - transport = transports.AddressValidationRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.AddressValidationRestInterceptor(), - ) - client = AddressValidationClient(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.AddressValidationRestInterceptor, "post_provide_validation_feedback") as post, \ - mock.patch.object(transports.AddressValidationRestInterceptor, "pre_provide_validation_feedback") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = address_validation_service.ProvideValidationFeedbackRequest.pb(address_validation_service.ProvideValidationFeedbackRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = address_validation_service.ProvideValidationFeedbackResponse.to_json(address_validation_service.ProvideValidationFeedbackResponse()) - - request = address_validation_service.ProvideValidationFeedbackRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = address_validation_service.ProvideValidationFeedbackResponse() - - client.provide_validation_feedback(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_provide_validation_feedback_rest_bad_request(transport: str = 'rest', request_type=address_validation_service.ProvideValidationFeedbackRequest): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.provide_validation_feedback(request) - - -def test_provide_validation_feedback_rest_error(): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AddressValidationClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = AddressValidationClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = AddressValidationClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = AddressValidationClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = AddressValidationClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.AddressValidationGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.AddressValidationGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.AddressValidationGrpcTransport, - transports.AddressValidationGrpcAsyncIOTransport, - transports.AddressValidationRestTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = AddressValidationClient.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.AddressValidationGrpcTransport, - ) - -def test_address_validation_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.AddressValidationTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_address_validation_base_transport(): - # Instantiate the base transport. - with mock.patch('google.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.AddressValidationTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'validate_address', - 'provide_validation_feedback', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -def test_address_validation_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.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AddressValidationTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( -), - quota_project_id="octopus", - ) - - -def test_address_validation_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.maps.addressvalidation_v1.services.address_validation.transports.AddressValidationTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.AddressValidationTransport() - adc.assert_called_once() - - -def test_address_validation_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) - AddressValidationClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.AddressValidationGrpcTransport, - transports.AddressValidationGrpcAsyncIOTransport, - ], -) -def test_address_validation_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=(), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.AddressValidationGrpcTransport, - transports.AddressValidationGrpcAsyncIOTransport, - transports.AddressValidationRestTransport, - ], -) -def test_address_validation_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.AddressValidationGrpcTransport, grpc_helpers), - (transports.AddressValidationGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_address_validation_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( - "addressvalidation.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( -), - scopes=["1", "2"], - default_host="addressvalidation.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) -def test_address_validation_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - -def test_address_validation_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.AddressValidationRestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_address_validation_host_no_port(transport_name): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='addressvalidation.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'addressvalidation.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://addressvalidation.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_address_validation_host_with_port(transport_name): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='addressvalidation.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'addressvalidation.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://addressvalidation.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_address_validation_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = AddressValidationClient( - credentials=creds1, - transport=transport_name, - ) - client2 = AddressValidationClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.validate_address._session - session2 = client2.transport.validate_address._session - assert session1 != session2 - session1 = client1.transport.provide_validation_feedback._session - session2 = client2.transport.provide_validation_feedback._session - assert session1 != session2 -def test_address_validation_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AddressValidationGrpcTransport( - 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_address_validation_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.AddressValidationGrpcAsyncIOTransport( - 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.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) -def test_address_validation_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.AddressValidationGrpcTransport, transports.AddressValidationGrpcAsyncIOTransport]) -def test_address_validation_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = AddressValidationClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = AddressValidationClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = AddressValidationClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = AddressValidationClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = AddressValidationClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = AddressValidationClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = AddressValidationClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = AddressValidationClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = AddressValidationClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = AddressValidationClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = AddressValidationClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = AddressValidationClient.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 = AddressValidationClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = AddressValidationClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = AddressValidationClient.parse_common_location_path(path) - assert expected == actual - - -def test_client_with_default_client_info(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.AddressValidationTransport, '_prep_wrapped_messages') as prep: - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.AddressValidationTransport, '_prep_wrapped_messages') as prep: - transport_class = AddressValidationClient.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = AddressValidationAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - - -def test_transport_close(): - transports = { - "rest": "_session", - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'rest', - 'grpc', - ] - for transport in transports: - client = AddressValidationClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - # Test client calls underlying transport. - with mock.patch.object(type(client.transport), "close") as close: - close.assert_not_called() - with client: - pass - close.assert_called() - -@pytest.mark.parametrize("client_class,transport_class", [ - (AddressValidationClient, transports.AddressValidationGrpcTransport), - (AddressValidationAsyncClient, transports.AddressValidationGrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience=None, - ) diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py index f6e1da257102..c6ab552b539a 100644 --- a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py +++ b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address.py @@ -138,10 +138,13 @@ class AddressComponent(proto.Message): location and believe it should be provided for a complete address. spell_corrected (bool): - Indicates the spelling of the component name - was corrected in a minor way, for example by - switching two characters that appeared in the - wrong order. This indicates a cosmetic change. + Indicates a correction to a misspelling in + the component name. The API does not always + flag changes from one spelling variant to + another, such as when changing "centre" to + "center". It also does not always flag common + misspellings, such as when changing + "Amphitheater Pkwy" to "Amphitheatre Pkwy". replaced (bool): Indicates the name of the component was replaced with a completely different one, for diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py index 6422595b92ce..beed7f4aa662 100644 --- a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py +++ b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/address_validation_service.py @@ -50,8 +50,8 @@ class ValidateAddressRequest(proto.Message): The total length of the fields in this input must not exceed 280 characters. - Supported regions can be found in the - `FAQ `__. + Supported regions can be found + `here `__. The [language_code][google.type.PostalAddress.language_code] value in the input address is reserved for future uses and @@ -89,6 +89,30 @@ class ValidateAddressRequest(proto.Message): [google.type.PostalAddress.address_lines] where the first line contains the street number and name and the second line contains the city, state, and zip code. + session_token (str): + Optional. A string which identifies an Autocomplete session + for billing purposes. Must be a URL and filename safe base64 + string with at most 36 ASCII characters in length. Otherwise + an INVALID_ARGUMENT error is returned. + + The session begins when the user starts typing a query, and + concludes when they select a place and a call to Place + Details or Address Validation is made. Each session can have + multiple autocomplete queries, followed by one Place Details + or Address Validation request. The credentials used for each + request within a session must belong to the same Google + Cloud Console project. Once a session has concluded, the + token is no longer valid; your app must generate a fresh + token for each session. If the ``session_token`` parameter + is omitted, or if you reuse a session token, the session is + charged as if no session token was provided (each request is + billed separately). + + Note: Address Validation can only be used in sessions with + the Autocomplete (New) API, not the old Autocomplete API. + See + https://developers.google.com/maps/documentation/places/web-service/session-pricing + for more details. """ address: postal_address_pb2.PostalAddress = proto.Field( @@ -104,6 +128,10 @@ class ValidateAddressRequest(proto.Message): proto.BOOL, number=3, ) + session_token: str = proto.Field( + proto.STRING, + number=5, + ) class ValidateAddressResponse(proto.Message): @@ -329,7 +357,7 @@ class Granularity(proto.Enum): PREMISE (2): Building-level result. PREMISE_PROXIMITY (3): - A geocode that should be very close to the + A geocode that approximates the building-level location of the address. BLOCK (4): The address or geocode indicates a block. diff --git a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py index 936819a98fa8..1984352684fb 100644 --- a/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py +++ b/packages/google-maps-addressvalidation/google/maps/addressvalidation_v1/types/usps_data.py @@ -110,17 +110,20 @@ class UspsData(proto.Message): should yield a number divisible by 10. dpv_confirmation (str): The possible values for DPV confirmation. Returns a single - character. + character or returns no value. - - ``Y``: Address was DPV confirmed for primary and any - secondary numbers. - ``N``: Primary and any secondary number information failed to DPV confirm. - - ``S``: Address was DPV confirmed for the primary number - only, and the secondary number information was present by - not confirmed. - ``D``: Address was DPV confirmed for the primary number only, and the secondary number information was missing. + - ``S``: Address was DPV confirmed for the primary number + only, and the secondary number information was present + but not confirmed. + - ``Y``: Address was DPV confirmed for primary and any + secondary numbers. + - Empty: If the response does not contain a + ``dpv_confirmation`` value, the address was not submitted + for DPV confirmation. dpv_footnote (str): The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string. @@ -128,12 +131,12 @@ class UspsData(proto.Message): - ``AA``: Input address matched to the ZIP+4 file - ``A1``: Input address was not matched to the ZIP+4 file - ``BB``: Matched to DPV (all components) - - ``CC``: Secondary number not matched (present but - invalid) + - ``CC``: Secondary number not matched and not required + - ``C1``: Secondary number not matched but required - ``N1``: High-rise address missing secondary number - ``M1``: Primary number missing - ``M3``: Primary number invalid - - ``P1``: Input address RR or HC box number missing + - ``P1``: Input address PO, RR or HC box number missing - ``P3``: Input address PO, RR, or HC Box number invalid - ``F1``: Input address matched to a military address - ``G1``: Input address matched to a general delivery @@ -143,6 +146,9 @@ class UspsData(proto.Message): - ``RR``: DPV confirmed address with PMB information - ``R1``: DPV confirmed address without PMB information - ``R7``: Carrier Route R777 or R779 record + - ``IA``: Informed Address identified + - ``TA``: Primary number matched by dropping a trailing + alpha dpv_cmra (str): Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for @@ -163,6 +169,95 @@ class UspsData(proto.Message): - ``Y``: The address is not active - ``N``: The address is active + dpv_no_stat_reason_code (int): + Indicates the NoStat type. Returns a reason code as int. + + - ``1``: IDA (Internal Drop Address) – Addresses that do + not receive mail directly from the USPS but are delivered + to a drop address that services them. + - ``2``: CDS - Addresses that have not yet become + deliverable. For example, a new subdivision where lots + and primary numbers have been determined, but no + structure exists yet for occupancy. + - ``3``: Collision - Addresses that do not actually DPV + confirm. + - ``4``: CMZ (College, Military and Other Types) - ZIP + 4 + records USPS has incorporated into the data. + - ``5``: Regular - Indicates addresses not receiving + delivery and the addresses are not counted as possible + deliveries. + - ``6``: Secondary Required - The address requires + secondary information. + dpv_drop (str): + Flag indicates mail is delivered to a single receptable at a + site. Returns a single character. + + - ``Y``: The mail is delivered to a single receptable at a + site. + - ``N``: The mail is not delivered to a single receptable + at a site. + dpv_throwback (str): + Indicates that mail is not delivered to the street address. + Returns a single character. + + - ``Y``: The mail is not delivered to the street address. + - ``N``: The mail is delivered to the street address. + dpv_non_delivery_days (str): + Flag indicates mail delivery is not performed every day of + the week. Returns a single character. + + - ``Y``: The mail delivery is not performed every day of + the week. + - ``N``: No indication the mail delivery is not performed + every day of the week. + dpv_non_delivery_days_values (int): + Integer identifying non-delivery days. It can + be interrogated using bit flags: + + 0x40 – Sunday is a non-delivery day + 0x20 – Monday is a non-delivery day + 0x10 – Tuesday is a non-delivery day + 0x08 – Wednesday is a non-delivery day + 0x04 – Thursday is a non-delivery day + 0x02 – Friday is a non-delivery day + 0x01 – Saturday is a non-delivery day + dpv_no_secure_location (str): + Flag indicates door is accessible, but package will not be + left due to security concerns. Returns a single character. + + - ``Y``: The package will not be left due to security + concerns. + - ``N``: No indication the package will not be left due to + security concerns. + dpv_pbsa (str): + Indicates the address was matched to PBSA record. Returns a + single character. + + - ``Y``: The address was matched to PBSA record. + - ``N``: The address was not matched to PBSA record. + dpv_door_not_accessible (str): + Flag indicates addresses where USPS cannot knock on a door + to deliver mail. Returns a single character. + + - ``Y``: The door is not accessible. + - ``N``: No indication the door is not accessible. + dpv_enhanced_delivery_code (str): + Indicates that more than one DPV return code is valid for + the address. Returns a single character. + + - ``Y``: Address was DPV confirmed for primary and any + secondary numbers. + - ``N``: Primary and any secondary number information + failed to DPV confirm. + - ``S``: Address was DPV confirmed for the primary number + only, and the secondary number information was present by + not confirmed, or a single trailing alpha on a primary + number was dropped to make a DPV match and secondary + information required. + - ``D``: Address was DPV confirmed for the primary number + only, and the secondary number information was missing. + - ``R``: Address confirmed but assigned to phantom route + R777 and R779 and USPS delivery is not provided. carrier_route (str): The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator. @@ -276,6 +371,42 @@ class UspsData(proto.Message): proto.STRING, number=8, ) + dpv_no_stat_reason_code: int = proto.Field( + proto.INT32, + number=29, + ) + dpv_drop: str = proto.Field( + proto.STRING, + number=30, + ) + dpv_throwback: str = proto.Field( + proto.STRING, + number=31, + ) + dpv_non_delivery_days: str = proto.Field( + proto.STRING, + number=32, + ) + dpv_non_delivery_days_values: int = proto.Field( + proto.INT32, + number=33, + ) + dpv_no_secure_location: str = proto.Field( + proto.STRING, + number=34, + ) + dpv_pbsa: str = proto.Field( + proto.STRING, + number=35, + ) + dpv_door_not_accessible: str = proto.Field( + proto.STRING, + number=36, + ) + dpv_enhanced_delivery_code: str = proto.Field( + proto.STRING, + number=37, + ) carrier_route: str = proto.Field( proto.STRING, number=9, diff --git a/packages/google-maps-addressvalidation/scripts/fixup_addressvalidation_v1_keywords.py b/packages/google-maps-addressvalidation/scripts/fixup_addressvalidation_v1_keywords.py index 6183b22b01f0..07ecb8b60bc3 100644 --- a/packages/google-maps-addressvalidation/scripts/fixup_addressvalidation_v1_keywords.py +++ b/packages/google-maps-addressvalidation/scripts/fixup_addressvalidation_v1_keywords.py @@ -40,7 +40,7 @@ class addressvalidationCallTransformer(cst.CSTTransformer): CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { 'provide_validation_feedback': ('conclusion', 'response_id', ), - 'validate_address': ('address', 'previous_response_id', 'enable_usps_cass', ), + 'validate_address': ('address', 'previous_response_id', 'enable_usps_cass', 'session_token', ), } def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: