feat: migrate to pyproject.toml (#13550)

Tracking issue #13171 Previous PR: googleapis/python-grpc-google-iam-v1#112 Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-cloud-python/issues) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #<issue_number_goes_here> 🦕 --------- Co-authored-by: Anthonios Partheniou <partheniou@google.com>

Author: rinarakaki

packages/grpc-google-iam-v1/README.rst

@@ -26,12 +26,12 @@ 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 Cloud Identity and Access Management.`_
-4. `Setup Authentication.`_
+4. `Set up 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
 .. _Enable the Cloud Identity and Access Management.: https://cloud.google.com/iam/docs/
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~
@@ -106,3 +106,92 @@ Next Steps
 
 .. _Cloud Identity and Access Management Product documentation: https://cloud.google.com/iam/docs/
 .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
+
+Logging
+-------
+
+This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
+Note the following:
+
+#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
+#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
+#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
+
+Simple, environment-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
+logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
+messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
+event.
+
+A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
+
+- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
+- Invalid logging scopes: :code:`foo`, :code:`123`, etc.
+
+**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
+
+Environment-Based Examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Enabling the default handler for all Google-based loggers
+
+.. code-block:: console
+
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
+
+- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: console
+
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
+
+
+Advanced, code-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can also configure a valid logging scope using Python's standard `logging` mechanism.
+
+Code-Based Examples
+^^^^^^^^^^^^^^^^^^^
+
+- Configuring a handler for all Google-based loggers
+
+.. code-block:: python
+
+ import logging
+ 
+ from google.cloud.translate_v3 import translate
+ 
+ base_logger = logging.getLogger("google")
+ base_logger.addHandler(logging.StreamHandler())
+ base_logger.setLevel(logging.DEBUG)
+
+- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: python
+
+ import logging
+ 
+ from google.cloud.translate_v3 import translate
+ 
+ base_logger = logging.getLogger("google.cloud.library_v1")
+ base_logger.addHandler(logging.StreamHandler())
+ base_logger.setLevel(logging.DEBUG)
+
+Logging details
+~~~~~~~~~~~~~~~
+
+#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
+ :code:`logging.getLogger("google").propagate = True` in your code.
+#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
+ one library, but decide you need to also set up environment-based logging configuration for another library.
+
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
+ if the code -based configuration gets applied first.
+
+#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
+ (This is the reason for 2.i. above.)

packages/grpc-google-iam-v1/noxfile.py

@@ -382,20 +382,29 @@ def docfx(session):
  ["python", "upb", "cpp"],
 )
 def prerelease_deps(session, protobuf_implementation):
- """Run all tests with prerelease versions of dependencies installed."""
+ """
+ Run all tests with pre-release versions of dependencies installed
+ rather than the standard non pre-release versions.
+ Pre-releases versions can be installed using
+ `pip install --pre <package>`.
+ """
 
  if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12", "3.13"):
  session.skip("cpp implementation is not supported in python 3.11+")
 
  # Install all dependencies
- session.install("-e", ".[all, tests, tracing]")
+ session.install("-e", ".")
+
  unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES
+ # Install dependencies for the unit test environment
  session.install(*unit_deps_all)
+
  system_deps_all = (
  SYSTEM_TEST_STANDARD_DEPENDENCIES
  + SYSTEM_TEST_EXTERNAL_DEPENDENCIES
  + SYSTEM_TEST_EXTRAS
  )
+ # Install dependencies for the system test environment
  session.install(*system_deps_all)
 
  # Because we test minimum dependency versions on the minimum Python
@@ -417,6 +426,7 @@ def prerelease_deps(session, protobuf_implementation):
  )
  ]
 
+ # Install dependencies specified in `testing/constraints-X.txt`.
  session.install(*constraints_deps)
 
  prerel_deps = [
@@ -458,3 +468,70 @@ def prerelease_deps(session, protobuf_implementation):
  "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,
  },
  )
+
+
+@nox.session(python="3.13")
+@nox.parametrize(
+ "protobuf_implementation",
+ ["python", "upb"],
+)
+def core_deps_from_source(session, protobuf_implementation):
+ """Run all tests with local versions of core dependencies installed,
+ rather than pulling core dependencies from PyPI.
+ """
+
+ # Install all dependencies
+ session.install(".")
+
+ # Install dependencies for the unit test environment
+ unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES
+ session.install(*unit_deps_all)
+
+ # Install dependencies for the system test environment
+ system_deps_all = (
+ SYSTEM_TEST_STANDARD_DEPENDENCIES
+ + SYSTEM_TEST_EXTERNAL_DEPENDENCIES
+ + SYSTEM_TEST_EXTRAS
+ )
+ session.install(*system_deps_all)
+
+ # Because we test minimum dependency versions on the minimum Python
+ # version, the first version we test with in the unit tests sessions has a
+ # constraints file containing all dependencies and extras that should be installed.
+ with open(
+ CURRENT_DIRECTORY
+ / "testing"
+ / f"constraints-{UNIT_TEST_PYTHON_VERSIONS[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
+ )
+ ]
+
+ # Install dependencies specified in `testing/constraints-X.txt`.
+ session.install(*constraints_deps)
+
+ core_dependencies_from_source = [
+ "google-api-core @ git+https://github.com/googleapis/python-api-core.git",
+ "google-auth @ git+https://github.com/googleapis/google-auth-library-python.git",
+ f"{CURRENT_DIRECTORY}/../googleapis-common-protos",
+ f"{CURRENT_DIRECTORY}/../grpc-google-iam-v1",
+ "proto-plus @ git+https://github.com/googleapis/proto-plus-python.git",
+ ]
+
+ for dep in core_dependencies_from_source:
+ session.install(dep, "--ignore-installed", "--no-deps")
+
+ session.run(
+ "py.test",
+ "tests/unit",
+ env={
+ "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation,
+ },
+ )

packages/grpc-google-iam-v1/pyproject.toml

@@ -0,0 +1,53 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "grpc-google-iam-v1"
+version = "0.14.0"
+authors = [{ name = "Google LLC", email = "googleapis-packages@google.com" }]
+license = { text = "Apache 2.0" }
+requires-python = ">=3.7"
+description = "IAM API client library"
+readme = "README.rst"
+classifiers = [
+ "Development Status :: 4 - Beta",
+ "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",
+ "Programming Language :: Python :: 3.13",
+ "Operating System :: OS Independent",
+ "Topic :: Internet",
+]
+dependencies = [
+ "grpcio >= 1.44.0, < 2.0.0dev",
+ "googleapis-common-protos[grpc] >= 1.56.0, < 2.0.0dev",
+ "protobuf >= 3.20.2, < 6.0.0dev, != 4.21.1, != 4.21.2, != 4.21.3, != 4.21.4, != 4.21.5",
+]
+
+[project.urls]
+Repository = "https://github.com/googleapis/google-cloud-python"
+
+[tool.setuptools.packages.find]
+include = ["google*"]

packages/grpc-google-iam-v1/setup.py

@@ -14,63 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import io
-import os
-
 import setuptools
 
-name = "grpc-google-iam-v1"
-description = "IAM API client library"
-version = "0.14.0"
-url = "https://github.com/googleapis/google-cloud-python"
-release_status = "Development Status :: 4 - Beta"
-dependencies = [
- "grpcio>=1.44.0, <2.0.0dev",
- "googleapis-common-protos[grpc]>=1.56.0, <2.0.0dev",
- "protobuf>=3.20.2,<6.0.0dev,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
-]
-
-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",
- "Programming Language :: Python :: 3.13",
- "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,
-)
+setuptools.setup()