Merge branch 'main' into any-error

parthea · web-flow · commit 7a1e1d054042 · 2024-10-19T14:08:48.000-04:00
diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml
@@ -19,6 +19,7 @@ jobs:
           - "3.10"
           - "3.11"
           - "3.12"
+          - "3.13"
         exclude:
           - option: "_wo_grpc"
             python: 3.7
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -21,7 +21,7 @@ In order to add a feature:
   documentation.
 
 - The feature must work fully on the following CPython versions:
-  3.7, 3.8, 3.9, 3.10, 3.11 and 3.12 on both UNIX and Windows.
+  3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and 3.13 on both UNIX and Windows.
 
 - The feature must not add unnecessary dependencies (where
   "unnecessary" is of course subjective, but new dependencies should
@@ -71,7 +71,7 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
 
 - To run a single unit test::
 
-    $ nox -s unit-3.12 -- -k <name of test>
+    $ nox -s unit-3.13 -- -k <name of test>
 
 
   .. note::
@@ -203,13 +203,15 @@ We support:
 -  `Python 3.10`_
 -  `Python 3.11`_
 -  `Python 3.12`_
+-  `Python 3.13`_
 
 .. _Python 3.7: https://docs.python.org/3.7/
 .. _Python 3.8: https://docs.python.org/3.8/
 .. _Python 3.9: https://docs.python.org/3.9/
 .. _Python 3.10: https://docs.python.org/3.10/
 .. _Python 3.11: https://docs.python.org/3.11/
 .. _Python 3.12: https://docs.python.org/3.12/
+.. _Python 3.13: https://docs.python.org/3.13/
 
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
diff --git a/google/api_core/client_options.py b/google/api_core/client_options.py
@@ -48,18 +48,20 @@ def get_client_cert():
 
 """
 
+from typing import Callable, Mapping, Optional, Sequence, Tuple
+
 
 class ClientOptions(object):
     """Client Options used to set options on clients.
 
     Args:
         api_endpoint (Optional[str]): The desired API endpoint, e.g.,
             compute.googleapis.com
-        client_cert_source (Optional[Callable[[], (bytes, bytes)]]): A callback
+        client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): A callback
             which returns client certificate bytes and private key bytes both in
             PEM format. ``client_cert_source`` and ``client_encrypted_cert_source``
             are mutually exclusive.
-        client_encrypted_cert_source (Optional[Callable[[], (str, str, bytes)]]):
+        client_encrypted_cert_source (Optional[Callable[[], Tuple[str, str, bytes]]]):
             A callback which returns client certificate file path, encrypted
             private key file path, and the passphrase bytes.``client_cert_source``
             and ``client_encrypted_cert_source`` are mutually exclusive.
@@ -88,15 +90,17 @@ class ClientOptions(object):
 
     def __init__(
         self,
-        api_endpoint=None,
-        client_cert_source=None,
-        client_encrypted_cert_source=None,
-        quota_project_id=None,
-        credentials_file=None,
-        scopes=None,
-        api_key=None,
-        api_audience=None,
-        universe_domain=None,
+        api_endpoint: Optional[str] = None,
+        client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
+        client_encrypted_cert_source: Optional[
+            Callable[[], Tuple[str, str, bytes]]
+        ] = None,
+        quota_project_id: Optional[str] = None,
+        credentials_file: Optional[str] = None,
+        scopes: Optional[Sequence[str]] = None,
+        api_key: Optional[str] = None,
+        api_audience: Optional[str] = None,
+        universe_domain: Optional[str] = None,
     ):
         if client_cert_source and client_encrypted_cert_source:
             raise ValueError(
@@ -114,11 +118,11 @@ def __init__(
         self.api_audience = api_audience
         self.universe_domain = universe_domain
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return "ClientOptions: " + repr(self.__dict__)
 
 
-def from_dict(options):
+def from_dict(options: Mapping[str, object]) -> ClientOptions:
     """Construct a client options object from a mapping object.
 
     Args:
diff --git a/noxfile.py b/noxfile.py
@@ -28,7 +28,7 @@
 # Black and flake8 clash on the syntax for ignoring flake8's F401 in this file.
 BLACK_EXCLUDES = ["--exclude", "^/google/api_core/operations_v1/__init__.py"]
 
-PYTHON_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+PYTHON_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
 DEFAULT_PYTHON_VERSION = "3.10"
 CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()
@@ -95,7 +95,8 @@ def install_prerelease_dependencies(session, constraints_path):
         prerel_deps = [
             "google-auth",
             "googleapis-common-protos",
-            "grpcio",
+            # Exclude grpcio!=1.67.0rc1 which does not support python 3.13
+            "grpcio!=1.67.0rc1",
             "grpcio-status",
             "proto-plus",
             "protobuf",
@@ -132,6 +133,7 @@ def default(session, install_grpc=True, prerelease=False, install_async_rest=Fal
 
     install_extras = []
     if install_grpc:
+        # Note: The extra is called `grpc` and not `grpcio`.
         install_extras.append("grpc")
 
     constraints_dir = str(CURRENT_DIRECTORY / "testing")
diff --git a/setup.py b/setup.py
@@ -93,6 +93,7 @@
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
         "Operating System :: OS Independent",
         "Topic :: Internet",
     ],
diff --git a/testing/constraints-3.13.txt b/testing/constraints-3.13.txt
diff --git a/tests/asyncio/retry/test_retry_streaming_async.py b/tests/asyncio/retry/test_retry_streaming_async.py
@@ -139,6 +139,7 @@ async def test___call___generator_retry(self, sleep):
         unpacked = [await generator.__anext__() for i in range(10)]
         assert unpacked == [0, 1, 2, 0, 1, 2, 0, 1, 2, 0]
         assert on_error.call_count == 3
+        await generator.aclose()
 
     @mock.patch("random.uniform", autospec=True, side_effect=lambda m, n: n)
     @mock.patch("asyncio.sleep", autospec=True)
@@ -246,6 +247,7 @@ async def _mock_send_gen():
             recv = await generator.asend(msg)
             out_messages.append(recv)
         assert in_messages == out_messages
+        await generator.aclose()
 
     @mock.patch("asyncio.sleep", autospec=True)
     @pytest.mark.asyncio
@@ -263,6 +265,7 @@ async def test___call___generator_send_retry(self, sleep):
         with pytest.raises(TypeError) as exc_info:
             await generator.asend("cannot send to fresh generator")
             assert exc_info.match("can't send non-None value")
+        await generator.aclose()
 
         # error thrown on 3
         # generator should contain 0, 1, 2 looping
@@ -271,6 +274,7 @@ async def test___call___generator_send_retry(self, sleep):
         unpacked = [await generator.asend(i) for i in range(10)]
         assert unpacked == [1, 2, 0, 1, 2, 0, 1, 2, 0, 1]
         assert on_error.call_count == 3
+        await generator.aclose()
 
     @mock.patch("asyncio.sleep", autospec=True)
     @pytest.mark.asyncio
@@ -382,6 +386,7 @@ async def wrapper():
         assert await retryable.asend("test") == 1
         assert await retryable.asend("test2") == 2
         assert await retryable.asend("test3") == 3
+        await retryable.aclose()
 
     @pytest.mark.parametrize("awaitable_wrapped", [True, False])
     @mock.patch("asyncio.sleep", autospec=True)
diff --git a/tests/asyncio/test_page_iterator_async.py b/tests/asyncio/test_page_iterator_async.py
@@ -110,6 +110,7 @@ async def test__page_aiter_increment(self):
         await page_aiter.__anext__()
 
         assert iterator.num_results == 1
+        await page_aiter.aclose()
 
     @pytest.mark.asyncio
     async def test__page_aiter_no_increment(self):
@@ -122,6 +123,7 @@ async def test__page_aiter_no_increment(self):
 
         # results should still be 0 after fetching a page.
         assert iterator.num_results == 0
+        await page_aiter.aclose()
 
     @pytest.mark.asyncio
     async def test__items_aiter(self):
