Skip to content

feat: data and pyi files in the venv #2936

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: data and pyi files in the venv #2936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9dd7589
wip: add symlinks for .dist-info folders in the venv
aignas May 27, 2025
1381bf8
Merge branch 'main' into exp/distinfo-venv
aignas May 29, 2025
42e5059
fixup
aignas May 29, 2025
d59f85a
add a failing test
aignas May 29, 2025
714b245
add a test for topological ordering preference
aignas May 30, 2025
31e16ee
correctly pop existing links for package overrides
aignas May 30, 2025
e0affec
finish impl
aignas May 30, 2025
c844aa0
cleanup stale docs
aignas May 30, 2025
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
4 changes: 2 additions & 2 deletions .bazelrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, execute
# `bazel run @rules_bazel_integration_test//tools:update_deleted_packages`
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/patches,examples/bzlmod/py_proto_library,examples/bzlmod/py_proto_library/example.com/another_proto,examples/bzlmod/py_proto_library/example.com/proto,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/another_proto,examples/py_proto_library/example.com/proto,gazelle,gazelle/manifest,gazelle/manifest/generate,gazelle/manifest/hasher,gazelle/manifest/test,gazelle/modules_mapping,gazelle/python,gazelle/pythonconfig,gazelle/python/private,tests/integration/compile_pip_requirements,tests/integration/compile_pip_requirements_test_from_external_repo,tests/integration/custom_commands,tests/integration/ignore_root_user_error,tests/integration/ignore_root_user_error/submodule,tests/integration/local_toolchains,tests/integration/pip_parse,tests/integration/pip_parse/empty,tests/integration/py_cc_toolchain_registered,tests/modules/other,tests/modules/other/nspkg_delta,tests/modules/other/nspkg_gamma,tests/modules/other/nspkg_single
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/patches,examples/bzlmod/py_proto_library,examples/bzlmod/py_proto_library/example.com/another_proto,examples/bzlmod/py_proto_library/example.com/proto,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/another_proto,examples/py_proto_library/example.com/proto,gazelle,gazelle/manifest,gazelle/manifest/generate,gazelle/manifest/hasher,gazelle/manifest/test,gazelle/modules_mapping,gazelle/python,gazelle/pythonconfig,gazelle/python/private,tests/integration/compile_pip_requirements,tests/integration/compile_pip_requirements_test_from_external_repo,tests/integration/custom_commands,tests/integration/ignore_root_user_error,tests/integration/ignore_root_user_error/submodule,tests/integration/local_toolchains,tests/integration/pip_parse,tests/integration/pip_parse/empty,tests/integration/py_cc_toolchain_registered,tests/modules/other,tests/modules/other/nspkg_delta,tests/modules/other/nspkg_gamma,tests/modules/other/nspkg_single
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/patches,examples/bzlmod/py_proto_library,examples/bzlmod/py_proto_library/example.com/another_proto,examples/bzlmod/py_proto_library/example.com/proto,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/another_proto,examples/py_proto_library/example.com/proto,gazelle,gazelle/manifest,gazelle/manifest/generate,gazelle/manifest/hasher,gazelle/manifest/test,gazelle/modules_mapping,gazelle/python,gazelle/pythonconfig,gazelle/python/private,tests/integration/compile_pip_requirements,tests/integration/compile_pip_requirements_test_from_external_repo,tests/integration/custom_commands,tests/integration/ignore_root_user_error,tests/integration/ignore_root_user_error/submodule,tests/integration/local_toolchains,tests/integration/pip_parse,tests/integration/pip_parse/empty,tests/integration/py_cc_toolchain_registered,tests/modules/other,tests/modules/other/nspkg_delta,tests/modules/other/nspkg_gamma,tests/modules/other/nspkg_single,tests/modules/other/simple_v1,tests/modules/other/simple_v2
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/patches,examples/bzlmod/py_proto_library,examples/bzlmod/py_proto_library/example.com/another_proto,examples/bzlmod/py_proto_library/example.com/proto,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/another_proto,examples/py_proto_library/example.com/proto,gazelle,gazelle/manifest,gazelle/manifest/generate,gazelle/manifest/hasher,gazelle/manifest/test,gazelle/modules_mapping,gazelle/python,gazelle/pythonconfig,gazelle/python/private,tests/integration/compile_pip_requirements,tests/integration/compile_pip_requirements_test_from_external_repo,tests/integration/custom_commands,tests/integration/ignore_root_user_error,tests/integration/ignore_root_user_error/submodule,tests/integration/local_toolchains,tests/integration/pip_parse,tests/integration/pip_parse/empty,tests/integration/py_cc_toolchain_registered,tests/modules/other,tests/modules/other/nspkg_delta,tests/modules/other/nspkg_gamma,tests/modules/other/nspkg_single,tests/modules/other/simple_v1,tests/modules/other/simple_v2

test --test_output=errors

Expand Down
1 change: 1 addition & 0 deletions python/private/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,7 @@ bzl_library(
":attributes_bzl",
":common_bzl",
":flags_bzl",
":normalize_name_bzl",
":precompile_bzl",
":py_cc_link_params_info_bzl",
":py_internal_bzl",
Expand Down
5 changes: 2 additions & 3 deletions python/private/common.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,9 +396,8 @@ def create_py_info(
implicit_pyc_files: {type}`depset[File]` Implicitly generated pyc files
that a binary can choose to include.
imports: depset of strings; the import path values to propagate.
venv_symlinks: {type}`list[tuple[str, str]]` tuples of
`(runfiles_path, site_packages_path)` for symlinks to create
in the consuming binary's venv site packages.
venv_symlinks: {type}`list[VenvSymlinkEntry]` instances for
symlinks to create in the consuming binary's venv.

Returns:
A tuple of the PyInfo instance and a depset of the
Expand Down
27 changes: 21 additions & 6 deletions python/private/py_executable.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,15 +682,30 @@ def _create_venv_symlinks(ctx, venv_dir_map):
def _build_link_map(entries):
# dict[str kind, dict[str rel_path, str link_to_path]]
link_map = {}

# Here we store venv paths by package
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type description makes it clear they're keyed by package, so no need to restate it in prose.

Suggested change
# Here we store venv paths by package

# dict[str package, dict[str kind, list[str venv_path]]]
pkg_map = {}
for entry in entries:
kind = entry.kind
kind_map = link_map.setdefault(kind, {})
if entry.venv_path in kind_map:
# We ignore duplicates by design. The dependency closer to the
# binary gets precedence due to the topological ordering.
continue
else:
kind_map[entry.venv_path] = entry.link_to_path

# If we detect that we are adding a dist-info for an already existing package
# we need to pop all of the previous symlinks from the link_map
Comment on lines +693 to +694
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the semantics to last-wins. We want first-wins so that the topological ordering has meaning.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you describe this in terms of what the end user should be able to do? I think we actually want the last wins? I am a little fuzzy about last vs first here. I added a test to what I think should be possible, so maybe we can discuss there.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A binary should be able to add a dependency closer to it to override behavior of further away targets.

"first" refers to topological ordering: the first item is closer. So given this:

py_binary(
  name = "bin",
  deps = [
    ":foo_v1",
    ":middle",
  ],
)
py_library(
  name = "middle",
  deps = [":foo_v2"]
)

Where foo_v1 and foo_v1 both produce a venv symlink for foo/lib.py

Then foo_v1's entry should be used and foo_v2's ignored. This is because the serialized order of bin's targets (i.e venv_symlinks.to_list()) follows topological order: foo_v1, middle, foo_v2

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this sort of test and I've found that the current logic is what I need. That is why I have simple_v1 and simple_v2 where simple_v2 is closer to the py_binary. Could you check out the PR and check it please? Maybe my knowledge of depsets is not deep enough.

if entry.venv_path.endswith(".dist-info") and entry.src in pkg_map:
# dist-info will come always first
for kind, dir_paths in pkg_map.pop(entry.src).items():
for dir_path in dir_paths:
link_map[kind].pop(dir_path)

pkg_venv_paths = pkg_map.setdefault(entry.src, {}).setdefault(entry.kind, [])
pkg_venv_paths.append(entry.venv_path)

# We overwrite duplicates by design. The dependency closer to the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to above: if an entry is being overwritten, it means the first-wins semantics aren't occurring.

# binary gets precedence due to the topological ordering.
#
# This allows us to store only one version of the dist-info that is needed
kind_map[entry.venv_path] = entry.link_to_path

# An empty link_to value means to not create the site package symlink.
# Because of the topological ordering, this allows binaries to remove
Expand Down
16 changes: 5 additions & 11 deletions python/private/py_info.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ the venv to create the path under.

A runfiles-root relative path that `venv_path` will symlink to. If `None`,
it means to not create a symlink.
""",
"src": """
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No comment on renaming this field?

:type: str | None

Represents the PyPI package that the code originates from.
""",
"venv_path": """
:type: str
Expand Down Expand Up @@ -298,17 +303,6 @@ This field is currently unused in Bazel and may go away in the future.

A depset with `topological` ordering.


Tuples of `(runfiles_path, site_packages_path)`. Where
* `runfiles_path` is a runfiles-root relative path. It is the path that
has the code to make importable. If `None` or empty string, then it means
to not create a site packages directory with the `site_packages_path`
name.
* `site_packages_path` is a path relative to the site-packages directory of
the venv for whatever creates the venv (typically py_binary). It makes
the code in `runfiles_path` available for import. Note that this
is created as a "raw" symlink (via `declare_symlink`).

:::{include} /_includes/experimental_api.md
:::

Expand Down
56 changes: 50 additions & 6 deletions python/private/py_library.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ load(
"runfiles_root_path",
)
load(":flags.bzl", "AddSrcsToRunfilesFlag", "PrecompileFlag", "VenvsSitePackages")
load(":normalize_name.bzl", "normalize_name")
load(":precompile.bzl", "maybe_precompile")
load(":py_cc_link_params_info.bzl", "PyCcLinkParamsInfo")
load(":py_info.bzl", "PyInfo", "VenvSymlinkEntry", "VenvSymlinkKind")
Expand Down Expand Up @@ -206,16 +207,32 @@ Source files are no longer added to the runfiles directly.
:::
"""

def _get_distinfo_metadata(ctx):
data = ctx.files.data or []
for d in data:
# work on case insensitive FSes
if d.basename.lower() != "metadata":
continue

if d.dirname.endswith(".dist-info"):
return d

return None

def _get_imports_and_venv_symlinks(ctx, semantics):
imports = depset()
venv_symlinks = depset()
if VenvsSitePackages.is_enabled(ctx):
venv_symlinks = _get_venv_symlinks(ctx)
dist_info_metadata = _get_distinfo_metadata(ctx)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: move the get_distinfo_metadata() call inside the _get_venv_symlinks function. The value isn't used outside that function and that function already has the necessary inputs to call it.

venv_symlinks = _get_venv_symlinks(
ctx,
dist_info_metadata,
)
else:
imports = collect_imports(ctx, semantics)
return imports, venv_symlinks

def _get_venv_symlinks(ctx):
def _get_venv_symlinks(ctx, dist_info_metadata):
imports = ctx.attr.imports
if len(imports) == 0:
fail("When venvs_site_packages is enabled, exactly one `imports` " +
Expand Down Expand Up @@ -254,16 +271,41 @@ def _get_venv_symlinks(ctx):
repo_runfiles_dirname = None
dirs_with_init = {} # dirname -> runfile path
venv_symlinks = []
for src in ctx.files.srcs:
if src.extension not in PYTHON_FILE_EXTENSIONS:
continue
package = None
if dist_info_metadata:
# in order to be able to have replacements in the venv, we have to add a
# third value into the venv_symlinks, which would be the normalized
# package name. This allows us to ensure that we can replace the `dist-info`
# directories by checking if the package key is there.
dist_info_dir = paths.basename(dist_info_metadata.dirname)
package, _, _suffix = dist_info_dir.rpartition(".dist-info")
package, _, _version = package.rpartition("-")
package = normalize_name(package)

repo_runfiles_dirname = runfiles_root_path(ctx, dist_info_metadata.short_path).partition("/")[0]
venv_symlinks.append(VenvSymlinkEntry(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There needs to be a comment somewhere around here that the particular ordering matters -- the dist-info must come before the other symlinks to ensure things are properly respected.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer true. It can come anywhere, I think.

kind = VenvSymlinkKind.LIB,
link_to_path = paths.join(repo_runfiles_dirname, site_packages_root, dist_info_dir),
src = package,
venv_path = dist_info_dir,
))

for src in ctx.files.srcs + ctx.files.data:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something seems wrong here, but I can't quite put my finger on it.

Files in srcs have to have the init.py logic applied to detect namespace package boundaries to auto-detect the proper paths to create.

Files in data shouldn't be part of that logic. If the file is within a directory covered by something in srcs (i.e *.py), then there's no need to look at the data file. If the data file isn't in a directory covered by something in srcs, then it shouldn't treat a .so/.pyi/.pyc file as some sort of boundary marker.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talking about special treatment, I don't think I understand why we need it. We could just treat everything as just files and interleave the directories? There is nothing special in my mind here.

Beforehand we had the auto-generated namespace pkg __init__.py files, but if we get rid of them everything is just files, right?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

treat everything as files and interleave the directories

You mean, for every file, create a venv_symlink entry? That won't scale because it doubles the number of files a binary has to materialize, when all that's really needed is e.g. one symlink to a directory.

However, because of namespace packages, we can't simply use the directories directly under site-packages/.

Copy link
Collaborator Author

@aignas aignas Jun 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if we treat everything as namespace packages? The way I understand this loop is:

  • For each file in the sources, symlink their directories.
  • If we have common things across data and srcs then we double the number of directories that we need to process, but I don't see a way to work around the case where we have a big package (e.g. airflow) that have data files under site-packages/airflow/data-files-without-python-files that would need to be symlinked in addition to other namespace packages.

I am wondering how we can do this?

path = _repo_relative_short_path(src.short_path)
if not path.startswith(site_packages_root):
continue
path = path.removeprefix(site_packages_root)
dir_name, _, filename = path.rpartition("/")

if dir_name and filename.startswith("__init__."):
if src.extension not in PYTHON_FILE_EXTENSIONS:
if dir_name.endswith(".dist-info"):
# we have already handled the stuff
pass
elif dir_name:
# TODO @aignas 2025-05-30: is this the right way?
dirs_with_init[dir_name] = None
repo_runfiles_dirname = runfiles_root_path(ctx, src.short_path).partition("/")[0]
elif dir_name and filename.startswith("__init__."):
dirs_with_init[dir_name] = None
repo_runfiles_dirname = runfiles_root_path(ctx, src.short_path).partition("/")[0]
elif not dir_name:
Expand All @@ -274,6 +316,7 @@ def _get_venv_symlinks(ctx):
venv_symlinks.append(VenvSymlinkEntry(
kind = VenvSymlinkKind.LIB,
link_to_path = paths.join(repo_runfiles_dirname, site_packages_root, filename),
src = package,
venv_path = filename,
))

Expand All @@ -295,6 +338,7 @@ def _get_venv_symlinks(ctx):
venv_symlinks.append(VenvSymlinkEntry(
kind = VenvSymlinkKind.LIB,
link_to_path = paths.join(repo_runfiles_dirname, site_packages_root, dirname),
src = package,
venv_path = dirname,
))
return venv_symlinks
Expand Down
14 changes: 14 additions & 0 deletions tests/modules/other/simple_v1/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
load("@rules_python//python:py_library.bzl", "py_library")

package(default_visibility = ["//visibility:public"])

py_library(
name = "simple_v1",
srcs = glob(["site-packages/**/*.py"]),
data = glob(
["**/*"],
exclude = ["site-packages/**/*.py"],
),
experimental_venvs_site_packages = "@rules_python//python/config_settings:venvs_site_packages",
imports = [package_name() + "/site-packages"],
)
1 change: 1 addition & 0 deletions tests/modules/other/simple_v1/site-packages/simple-1.0.0.dist-info/METADATA
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
inside is v1
1 change: 1 addition & 0 deletions tests/modules/other/simple_v1/site-packages/simple/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = "1.0.0"
1 change: 1 addition & 0 deletions tests/modules/other/simple_v1/site-packages/simple_extras/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Intentionally empty
15 changes: 15 additions & 0 deletions tests/modules/other/simple_v2/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
load("@rules_python//python:py_library.bzl", "py_library")

package(default_visibility = ["//visibility:public"])

py_library(
name = "simple_v2",
srcs = glob(["site-packages/**/*.py"]),
data = glob(
["**/*"],
exclude = ["site-packages/**/*.py"],
),
experimental_venvs_site_packages = "@rules_python//python/config_settings:venvs_site_packages",
imports = [package_name() + "/site-packages"],
pyi_srcs = glob(["**/*.pyi"]),
)
1 change: 1 addition & 0 deletions tests/modules/other/simple_v2/site-packages/simple-2.0.0.dist-info/METADATA
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
inside is v1
1 change: 1 addition & 0 deletions tests/modules/other/simple_v2/site-packages/simple.libs/data.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Intentionally empty
1 change: 1 addition & 0 deletions tests/modules/other/simple_v2/site-packages/simple/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = "2.0.0"
1 change: 1 addition & 0 deletions tests/modules/other/simple_v2/site-packages/simple/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Intentionally empty
15 changes: 15 additions & 0 deletions tests/venv_site_packages_libs/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
load("//python:py_library.bzl", "py_library")
load("//tests/support:py_reconfig.bzl", "py_reconfig_test")
load("//tests/support:support.bzl", "SUPPORTS_BOOTSTRAP_SCRIPT")

py_library(
name = "user_lib",
deps = ["@other//simple_v1"],
)

py_library(
name = "closer_lib",
deps = [
":user_lib",
"@other//simple_v2",
],
)

py_reconfig_test(
name = "venvs_site_packages_libs_test",
srcs = ["bin.py"],
Expand All @@ -9,6 +23,7 @@ py_reconfig_test(
target_compatible_with = SUPPORTS_BOOTSTRAP_SCRIPT,
venvs_site_packages = "yes",
deps = [
":closer_lib",
"//tests/venv_site_packages_libs/nspkg_alpha",
"//tests/venv_site_packages_libs/nspkg_beta",
"@other//nspkg_delta",
Expand Down
47 changes: 46 additions & 1 deletion tests/venv_site_packages_libs/bin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import importlib
import os
import sys
import unittest
from pathlib import Path


class VenvSitePackagesLibraryTest(unittest.TestCase):
Expand All @@ -27,6 +27,51 @@ def test_imported_from_venv(self):
self.assert_imported_from_venv("nspkg.subnspkg.gamma")
self.assert_imported_from_venv("nspkg.subnspkg.delta")
self.assert_imported_from_venv("single_file")
self.assert_imported_from_venv("simple")

def test_pyi_is_included(self):
self.assert_imported_from_venv("simple")
module = importlib.import_module("simple")
module_path = Path(module.__file__)

# this has been not included through data but through `pyi_srcs`
pyi_files = [p.name for p in module_path.parent.glob("*.pyi")]
self.assertIn("__init__.pyi", pyi_files)

def test_data_is_included(self):
self.assert_imported_from_venv("simple")
module = importlib.import_module("simple")
module_path = Path(module.__file__)

site_packages = module_path.parent.parent

# Ensure that packages from simple v1 are not present
files = [p.name for p in site_packages.glob("*")]
self.assertIn("simple.libs", files)

def test_override_pkg(self):
self.assert_imported_from_venv("simple")
module = importlib.import_module("simple")
self.assertEqual(
"2.0.0",
module.__version__,
)

def test_dirs_from_replaced_package_are_not_present(self):
self.assert_imported_from_venv("simple")
module = importlib.import_module("simple")
module_path = Path(module.__file__)

site_packages = module_path.parent.parent
dist_info_dirs = [p.name for p in site_packages.glob("*.dist-info")]
self.assertEqual(
["simple-2.0.0.dist-info"],
dist_info_dirs,
)

# Ensure that packages from simple v1 are not present
files = [p.name for p in site_packages.glob("*")]
self.assertNotIn("simple_extras", files)


if __name__ == "__main__":
Expand Down