Skip to content

Commit

Permalink
feat: Introduce compatibility with native namespace packages
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed Nov 14, 2023
1 parent 0baf3ef commit 8562e7d
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
9 changes: 7 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
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="google-cloud-documentai-toolbox",
author="Google LLC",
Expand All @@ -39,8 +45,7 @@
license="Apache 2.0",
long_description=readme,
long_description_content_type="text/x-rst",
packages=setuptools.PEP420PackageFinder.find(),
namespace_packages=("google", "google.cloud"),
packages=packages,
platforms="Posix; MacOS X; Windows",
include_package_data=True,
package_data={
Expand Down
37 changes: 37 additions & 0 deletions tests/unit/test_packaging.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2022 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-documentai-toolbox``.
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-documentai-toolbox``.
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)

0 comments on commit 8562e7d

Please sign in to comment.