Skip to content

Commit

Permalink
fix: migrate to native namespace packages (#187)
Browse files Browse the repository at this point in the history
* 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 <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Victor Chudnovsky <vchudnov@google.com>
  • Loading branch information
3 people committed Nov 28, 2023
1 parent 4643f9c commit 713e388
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 56 deletions.
Empty file removed google/api/__init__.py
Empty file.
Empty file removed google/gapic/metadata/__init__.py
Empty file.
24 changes: 0 additions & 24 deletions google/logging/__init__.py

This file was deleted.

Empty file removed google/logging/type/__init__.py
Empty file.
Empty file removed google/longrunning/__init__.py
Empty file.
24 changes: 0 additions & 24 deletions google/rpc/__init__.py

This file was deleted.

Empty file removed google/rpc/context/__init__.py
Empty file.
Empty file removed google/type/__init__.py
Empty file.
10 changes: 2 additions & 8 deletions setup.py
Expand Up @@ -16,6 +16,7 @@
import os

import setuptools
from setuptools import find_namespace_packages


name = "googleapis-common-protos"
Expand All @@ -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,
Expand All @@ -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,
)
52 changes: 52 additions & 0 deletions 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)

0 comments on commit 713e388

Please sign in to comment.