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 22, 2023
1 parent ca73f72 commit 21d411b
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 48 deletions.
19 changes: 0 additions & 19 deletions google/__init__.py

This file was deleted.

19 changes: 0 additions & 19 deletions google/cloud/__init__.py

This file was deleted.

12 changes: 4 additions & 8 deletions google/cloud/pubsublite/internal/wire/pubsub_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@
from typing import Mapping, Optional, NamedTuple

import logging
import pkg_resources

from google.protobuf import struct_pb2 # pytype: disable=pyi-error

from google.cloud.pubsublite import gapic_version


_LOGGER = logging.getLogger(__name__)

Expand All @@ -29,13 +31,7 @@ class _Semver(NamedTuple):


def _version() -> _Semver:
try:
version = pkg_resources.get_distribution("google-cloud-pubsublite").version
except pkg_resources.DistributionNotFound:
_LOGGER.info(
"Failed to extract the google-cloud-pubsublite semver version. DistributionNotFound."
)
return _Semver(0, 0)
version = gapic_version.__version__
splits = version.split(".")
if len(splits) != 3:
_LOGGER.info(f"Failed to extract semver from {version}.")
Expand Down
3 changes: 2 additions & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,8 @@ def pytype(session):
"""Run type checks."""
install_test_deps(session)
session.install(PYTYPE_VERSION)
session.run("pytype", "google/cloud/pubsublite")
# See https://github.com/google/pytype/issues/464
session.run("pytype", "-P", ".", "google/cloud/pubsublite")


@nox.session(python="3.10")
Expand Down
3 changes: 2 additions & 1 deletion owlbot.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,8 @@ def pytype(session):
\"\"\"Run type checks.\"\"\"
install_test_deps(session)
session.install(PYTYPE_VERSION)
session.run("pytype", "google/cloud/pubsublite")
# See https://github.com/google/pytype/issues/464
session.run("pytype", "-P", ".", "google/cloud/pubsublite")
@nox.session(python="3.10")
def docfx(session):""",
Expand Down
1 change: 1 addition & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"release-type": "python",
"extra-files": [
"google/cloud/pubsublite/gapic_version.py",
"google/cloud/pubsublite_v1/gapic_version.py",
{
"type": "json",
"path": "samples/generated_samples/snippet_metadata_google.cloud.pubsublite.v1.json",
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 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-pubsublite``.
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-pubsublite``.
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 21d411b

Please sign in to comment.