From 713e3887a3293aea314060e84bdcf8a12eda3d6c Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Tue, 28 Nov 2023 11:55:43 -0500 Subject: [PATCH] fix: migrate to native namespace packages (#187) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: drop pkg_resources * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix test to cater for new location for google-cloud-speech * typo * fix noxfile: install with -e * add test for google.logging --------- Co-authored-by: Owl Bot Co-authored-by: Victor Chudnovsky --- google/api/__init__.py | 0 google/gapic/metadata/__init__.py | 0 google/logging/__init__.py | 24 -------------- google/logging/type/__init__.py | 0 google/longrunning/__init__.py | 0 google/rpc/__init__.py | 24 -------------- google/rpc/context/__init__.py | 0 google/type/__init__.py | 0 setup.py | 10 ++---- tests/unit/test_packaging.py | 52 +++++++++++++++++++++++++++++++ 10 files changed, 54 insertions(+), 56 deletions(-) delete mode 100644 google/api/__init__.py delete mode 100644 google/gapic/metadata/__init__.py delete mode 100644 google/logging/__init__.py delete mode 100644 google/logging/type/__init__.py delete mode 100644 google/longrunning/__init__.py delete mode 100644 google/rpc/__init__.py delete mode 100644 google/rpc/context/__init__.py delete mode 100644 google/type/__init__.py create mode 100644 tests/unit/test_packaging.py diff --git a/google/api/__init__.py b/google/api/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/google/gapic/metadata/__init__.py b/google/gapic/metadata/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/google/logging/__init__.py b/google/logging/__init__.py deleted file mode 100644 index 9a1b64a..0000000 --- a/google/logging/__init__.py +++ /dev/null @@ -1,24 +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. - -try: - import pkg_resources - - pkg_resources.declare_namespace(__name__) -except ImportError: - import pkgutil - - __path__ = pkgutil.extend_path(__path__, __name__) diff --git a/google/logging/type/__init__.py b/google/logging/type/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/google/longrunning/__init__.py b/google/longrunning/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/google/rpc/__init__.py b/google/rpc/__init__.py deleted file mode 100644 index 9a1b64a..0000000 --- a/google/rpc/__init__.py +++ /dev/null @@ -1,24 +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. - -try: - import pkg_resources - - pkg_resources.declare_namespace(__name__) -except ImportError: - import pkgutil - - __path__ = pkgutil.extend_path(__path__, __name__) diff --git a/google/rpc/context/__init__.py b/google/rpc/context/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/google/type/__init__.py b/google/type/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/setup.py b/setup.py index e698295..596466c 100644 --- a/setup.py +++ b/setup.py @@ -16,6 +16,7 @@ import os import setuptools +from setuptools import find_namespace_packages name = "googleapis-common-protos" @@ -36,12 +37,6 @@ with io.open(readme_filename, encoding="utf-8") as readme_file: readme = readme_file.read() -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - setuptools.setup( name=name, version=version, @@ -66,10 +61,9 @@ install_requires=dependencies, extras_require=extras_require, license="Apache-2.0", - packages=packages, package_data={"": ["*.proto"]}, python_requires=">=3.7", - namespace_packages=["google", "google.logging"], + packages=find_namespace_packages(exclude=("tests*", "testing*")), url="https://github.com/googleapis/python-api-common-protos", include_package_data=True, ) diff --git a/tests/unit/test_packaging.py b/tests/unit/test_packaging.py new file mode 100644 index 0000000..f1ab3ff --- /dev/null +++ b/tests/unit/test_packaging.py @@ -0,0 +1,52 @@ +# 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 subprocess +import sys + + +def test_namespace_package_compat(tmp_path): + """ + The ``google`` namespace package should not be masked + by the presence of ``googleapis-common-protos``. + """ + google = tmp_path / "google" + google.mkdir() + google.joinpath("othermod.py").write_text("") + env = dict(os.environ, PYTHONPATH=str(tmp_path)) + cmd = [sys.executable, "-m", "google.othermod"] + subprocess.check_call(cmd, env=env) + + """ + The ``google.cloud`` namespace package should not be masked + by the presence of ``googleapis-common-protos``. + """ + google_cloud = tmp_path / "google/cloud" + google_cloud.mkdir() + google_cloud.joinpath("othermod.py").write_text("") + env = dict(os.environ, PYTHONPATH=str(tmp_path)) + cmd = [sys.executable, "-m", "google.cloud.othermod"] + subprocess.check_call(cmd, env=env) + + """ + The ``google.logging`` namespace package should not be masked + by the presence of ``googleapis-common-protos``. + """ + google_logging = tmp_path / "google/logging" + google_logging.mkdir() + google_logging.joinpath("othermod.py").write_text("") + env = dict(os.environ, PYTHONPATH=str(tmp_path)) + cmd = [sys.executable, "-m", "google.logging.othermod"] + subprocess.check_call(cmd, env=env)