Skip to content

fix: dependency resolver on windows only works when --enable_runfiles and --windows_enable_symlinks is used #2457

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

Merged
merged 6 commits into from
Dec 1, 2024
Merged

fix: dependency resolver on windows only works when --enable_runfiles and --windows_enable_symlinks is used #2457

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
452f59c
click commands will exit the whole program after being called if 'sta…
ChewyGumball Nov 28, 2024
5f915e9
Populating the runfiles tree is disabled by default on windows (ie --…
ChewyGumball Nov 29, 2024
1a6c903
Update CHANGELOG.md
ChewyGumball Nov 29, 2024
3b41efe
pip_compile requires that the file exist
ChewyGumball Nov 29, 2024
727379a
Update CHANGELOG.md with better syntax highlighting
ChewyGumball Nov 29, 2024
6d871ce
Merge branch 'main' into fix_dependency_resolver_on_windows
aignas Dec 1, 2024
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ Other changes:
([2169](https://github.com/bazelbuild/rules_python/issues/2169)).
* (workspace) Corrected protobuf's name to com_google_protobuf, the name is
hardcoded in Bazel, WORKSPACE mode.
* (pypi): compile_pip_requirements no longer fails on Windows when --enable_runfiles is not enabled
* (pypi): compile_pip_requirements now correctly updates files in the source tree on Windows when --windows_enable_symlinks is not enabled

{#v0-0-0-added}
### Added
Expand Down
13 changes: 10 additions & 3 deletions python/private/pypi/dependency_resolver/dependency_resolver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,19 +170,26 @@ def main(

if UPDATE:
print("Updating " + requirements_file_relative)

# Make sure the output file for pip_compile exists. It won't if we are on Windows and --enable_runfiles is not set.
if not os.path.exists(requirements_file_relative):
os.makedirs(os.path.dirname(requirements_file_relative), exist_ok=True)
shutil.copy(resolved_requirements_file, requirements_file_relative)

if "BUILD_WORKSPACE_DIRECTORY" in os.environ:
workspace = os.environ["BUILD_WORKSPACE_DIRECTORY"]
requirements_file_tree = os.path.join(workspace, requirements_file_relative)
absolute_output_file = Path(requirements_file_relative).absolute()
# In most cases, requirements_file will be a symlink to the real file in the source tree.
# If symlinks are not enabled (e.g. on Windows), then requirements_file will be a copy,
# and we should copy the updated requirements back to the source tree.
if not os.path.samefile(resolved_requirements_file, requirements_file_tree):
if not absolute_output_file.samefile(requirements_file_tree):
atexit.register(
lambda: shutil.copy(
resolved_requirements_file, requirements_file_tree
absolute_output_file, requirements_file_tree
)
)
cli(argv)
cli(argv, standalone_mode = False)
requirements_file_relative_path = Path(requirements_file_relative)
content = requirements_file_relative_path.read_text()
content = content.replace(absolute_path_prefix, "")
Expand Down