feat: Introduce compatibility with native namespace packages (#1024)

* feat: Introduce compatibility with native namespace packages

* use find_namespace_packages in setup.py

noxfile.py

@@ -106,7 +106,7 @@ def mypy(session):
     # TODO: Only check the hand-written layer, the generated code does not pass
     # mypy checks yet.
     # https://github.com/googleapis/gapic-generator-python/issues/1092
-    session.run("mypy", "google/cloud")
+    session.run("mypy", "-p", "google.cloud")
 
 
 @nox.session(python=DEFAULT_PYTHON_VERSION)

owlbot.py

@@ -383,7 +383,7 @@ def mypy(session):
         # TODO: Only check the hand-written layer, the generated code does not pass
         # mypy checks yet.
         # https://github.com/googleapis/gapic-generator-python/issues/1092
-        session.run("mypy", "google/cloud")'''
+        session.run("mypy", "-p", "google.cloud")'''
     ),
 )
 
@@ -399,7 +399,7 @@ def mypy(session):
 )
 s.replace(
     "noxfile.py",
-    r'session\.run\("mypy", "google/cloud"\)',
+    r'session\.run\("mypy", "-p", "google.cloud"\)',
     textwrap.dedent(
         '''    \g<0>
 

setup.py

@@ -56,14 +56,10 @@
 
 packages = [
     package
-    for package in setuptools.PEP420PackageFinder.find()
+    for package in setuptools.find_namespace_packages()
     if package.startswith("google")
 ]
 
-namespaces = ["google"]
-if "google.cloud" in packages:
-    namespaces.append("google.cloud")
-
 setuptools.setup(
     name=name,
     version=version,
@@ -89,7 +85,6 @@
     ],
     platforms="Posix; MacOS X; Windows",
     packages=packages,
-    namespace_packages=namespaces,
     install_requires=dependencies,
     extras_require=extras,
     python_requires=">=3.7",

tests/unit/test_packaging.py

@@ -0,0 +1,37 @@
+# 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 ``google-cloud-pubsub``.
+    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 ``google-cloud-pubsub``.
+    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)