Skip to content

fix(pypi): add __init__.py to site-packages directories #3220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

fix(pypi): add __init__.py to site-packages directories #3220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ END_UNRELEASED_TEMPLATE
* (bootstrap) The stage1 bootstrap script now correctly handles nested `RUNFILES_DIR`
environments, fixing issues where a `py_binary` calls another `py_binary`
([#3187](https://github.com/bazel-contrib/rules_python/issues/3187)).
* (pypi) Now the `site-packages` will also have the `__init__.py` file generated
for `namespace` packages to correctly support cases where one package may be a Python
file and the other package may be a proper directory module.
Fixes ([#3038](https://github.com/bazel-contrib/rules_python/issues/3038)).

{#v0-0-0-added}
### Added
Expand Down Expand Up @@ -228,7 +232,7 @@ END_UNRELEASED_TEMPLATE
### Fixed

* (pypi) Namespace packages work by default (pkgutil shims are generated
by default again)
by default again).
([#3038](https://github.com/bazel-contrib/rules_python/issues/3038)).

{#v1-5-0}
Expand Down
4 changes: 3 additions & 1 deletion python/private/pypi/namespace_pkgs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ def get_files(*, srcs, ignored_dirnames = [], root = None):
ignored = {i: None for i in ignored_dirnames}

if root:
_add_all(root, ignored)
dirname, _, filename = root.partition("/")
if filename:
_add_all(dirname, ignored)

for file in srcs:
dirname, _, filename = file.rpartition("/")
Expand Down
11 changes: 9 additions & 2 deletions tests/pypi/namespace_pkgs/namespace_pkgs_tests.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def test_find_correct_namespace_packages(env):

got = get_files(srcs = srcs, root = "nested/root")
expected = [
"nested/root",
"nested/root/foo",
"nested/root/foo/bar",
"nested/root/foo/bee",
Expand Down Expand Up @@ -148,6 +149,7 @@ def test_skips_ignored_directories(env):
]

expected = [
"root",
"root/foo",
"root/foo/bar",
]
Expand Down Expand Up @@ -182,16 +184,21 @@ def _test_create_inits(env):
env.expect.that_collection(copy_file_calls).contains_exactly([
{
"name": "_cp_0_namespace",
"out": "nested/root/foo/__init__.py",
"out": "nested/root/__init__.py",
"src": template,
},
{
"name": "_cp_1_namespace",
"out": "nested/root/foo/bar/__init__.py",
"out": "nested/root/foo/__init__.py",
"src": template,
},
{
"name": "_cp_2_namespace",
"out": "nested/root/foo/bar/__init__.py",
"src": template,
},
{
"name": "_cp_3_namespace",
"out": "nested/root/foo/bee/__init__.py",
"src": template,
},
Expand Down