feat: Add support for Python 3.12 (#1025)

* chore(python): Add Python 3.12

Source-Link: googleapis/synthtool@af16e6d
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:bacc3af03bff793a03add584537b36b5644342931ad989e3ba1171d3bd5399f5

* Add python 3.12 to setup.py and owlbot.py

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* fix incorrect usage of assert_called_once()

* update required checks

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>

.github/.OwlBot.lock.yaml

@@ -13,5 +13,5 @@
 # limitations under the License.
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
-  digest: sha256:caffe0a9277daeccc4d1de5c9b55ebba0901b57c2f713ec9c876b0d4ec064f61
-# created: 2023-11-08T19:46:45.022803742Z
+  digest: sha256:bacc3af03bff793a03add584537b36b5644342931ad989e3ba1171d3bd5399f5
+# created: 2023-11-23T18:17:28.105124211Z

.github/sync-repo-settings.yaml

@@ -15,4 +15,16 @@ branchProtectionRules:
     - 'Samples - Python 3.8'
     - 'Samples - Python 3.9'
     - 'Samples - Python 3.10'
+    - 'Samples - Python 3.11'
+    - 'Samples - Python 3.12'
     - 'OwlBot Post Processor'
+    - 'docs'
+    - 'docfx'
+    - 'lint'
+    - 'unit (3.7)'
+    - 'unit (3.8)'
+    - 'unit (3.9)'
+    - 'unit (3.10)'
+    - 'unit (3.11)'
+    - 'unit (3.12)'
+    - 'cover'

.github/workflows/unittest.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12']
     steps:
     - name: Checkout
       uses: actions/checkout@v3

.kokoro/samples/python3.12/common.cfg

@@ -0,0 +1,40 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+# Build logs will be here
+action {
+  define_artifacts {
+    regex: "**/*sponge_log.xml"
+  }
+}
+
+# Specify which tests to run
+env_vars: {
+    key: "RUN_TESTS_SESSION"
+    value: "py-3.12"
+}
+
+# Declare build specific Cloud project.
+env_vars: {
+    key: "BUILD_SPECIFIC_GCLOUD_PROJECT"
+    value: "python-docs-samples-tests-312"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-pubsub/.kokoro/test-samples.sh"
+}
+
+# Configure the docker image for kokoro-trampoline.
+env_vars: {
+    key: "TRAMPOLINE_IMAGE"
+    value: "gcr.io/cloud-devrel-kokoro-resources/python-samples-testing-docker"
+}
+
+# Download secrets for samples
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/python-docs-samples"
+
+# Download trampoline resources.
+gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline"
+
+# Use the trampoline script to run in docker.
+build_file: "python-pubsub/.kokoro/trampoline_v2.sh"

.kokoro/samples/python3.12/continuous.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}

.kokoro/samples/python3.12/periodic-head.cfg

@@ -0,0 +1,11 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}
+
+env_vars: {
+    key: "TRAMPOLINE_BUILD_FILE"
+    value: "github/python-pubsub/.kokoro/test-samples-against-head.sh"
+}

.kokoro/samples/python3.12/periodic.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "False"
+}

.kokoro/samples/python3.12/presubmit.cfg

@@ -0,0 +1,6 @@
+# Format: //devtools/kokoro/config/proto/build.proto
+
+env_vars: {
+    key: "INSTALL_LIBRARY_FROM_SOURCE"
+    value: "True"
+}

CONTRIBUTING.rst

@@ -22,7 +22,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 and 3.11 on both UNIX and Windows.
+  3.7, 3.8, 3.9, 3.10, 3.11 and 3.12 on both UNIX and Windows.
 
 - The feature must not add unnecessary dependencies (where
   "unnecessary" is of course subjective, but new dependencies should
@@ -72,7 +72,7 @@ We use `nox <https://nox.readthedocs.io/en/latest/>`__ to instrument our tests.
 
 - To run a single unit test::
 
-    $ nox -s unit-3.11 -- -k <name of test>
+    $ nox -s unit-3.12 -- -k <name of test>
 
 
   .. note::
@@ -226,12 +226,14 @@ We support:
 -  `Python 3.9`_
 -  `Python 3.10`_
 -  `Python 3.11`_
+-  `Python 3.12`_
 
 .. _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/
 
 
 Supported versions can be found in our ``noxfile.py`` `config`_.

noxfile.py

@@ -36,9 +36,9 @@
 
 DEFAULT_PYTHON_VERSION = "3.8"
 
-UNIT_TEST_PYTHON_VERSIONS: List[str] = ["3.7", "3.8", "3.9", "3.10", "3.11"]
+UNIT_TEST_PYTHON_VERSIONS: List[str] = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 UNIT_TEST_STANDARD_DEPENDENCIES = [
-    "mock==5.0.0",
+    "mock",
     "asyncmock",
     "pytest",
     "pytest-cov",
@@ -52,7 +52,7 @@
 
 SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.10"]
 SYSTEM_TEST_STANDARD_DEPENDENCIES: List[str] = [
-    "mock==5.0.0",
+    "mock",
     "pytest",
     "google-cloud-testutils",
 ]

owlbot.py

@@ -336,7 +336,7 @@
     samples=True,
     cov_level=100,
     versions=gcp.common.detect_versions(path="./google", default_first=True),
-    unit_test_python_versions=["3.7", "3.8", "3.9", "3.10", "3.11"],
+    unit_test_python_versions=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"],
     system_test_python_versions=["3.10"],
     system_test_external_dependencies=["psutil","flaky"],
 )
@@ -353,9 +353,6 @@
 s.replace(
     "noxfile.py", r'"blacken",', '\g<0>\n    "mypy",',
 )
-s.replace(
-    "noxfile.py", r'"mock"', '"mock==5.0.0"',
-)
 s.replace(
     "noxfile.py",
     r"nox\.options\.error_on_missing_interpreters = True",

samples/snippets/noxfile.py

@@ -89,7 +89,7 @@ def get_pytest_env_vars() -> Dict[str, str]:
 
 # DO NOT EDIT - automatically generated.
 # All versions used to test samples.
-ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11"]
+ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
 # Any default versions that should be ignored.
 IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"]

setup.py

@@ -80,6 +80,7 @@
         "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",
     ],

tests/unit/pubsub_v1/publisher/test_publisher_client.py

@@ -636,7 +636,7 @@ def test_resume_publish(creds):
     client._set_sequencer(topic=topic, sequencer=sequencer, ordering_key=ordering_key)
 
     client.resume_publish(topic, ordering_key)
-    assert sequencer.unpause.called_once()
+    sequencer.unpause.assert_called_once()
 
 
 def test_resume_publish_no_sequencer_found(creds):