feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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
aignas wants to merge 4 commits into from
Closed

feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbe64c0
feat: Store alias labels in requirements arrays if using bzlmod
aignas Jan 3, 2023
bddd80f
feat!: generate user friendly aliases for everyone
aignas Jan 27, 2023
223ca49
fixup: update the requirements vendoring example
aignas Jan 27, 2023
fc4c5fa
fixup: unit tests after a rebase
aignas Jan 27, 2023
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
3 changes: 2 additions & 1 deletion examples/bzlmod/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
name = "lib",
srcs = ["__init__.py"],
deps = [
requirement("pylint"),
# You can reference libraries using plain text form or the 'requirement' macro
"@pip//pylint",
requirement("tabulate"),
requirement("python-dateutil"),
],
Expand Down
8 changes: 4 additions & 4 deletions examples/pip_parse_vendored/requirements.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
if _bzlmod:
return "@@pip//:" + _clean_name(name) + "_pkg"
return "@@pip//" + _clean_name(name) + ":pkg"
return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
if _bzlmod:
return "@@pip//:" + _clean_name(name) + "_whl"
return "@@pip//" + _clean_name(name) + ":whl"
return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
if _bzlmod:
return "@@pip//:" + _clean_name(name) + "_data"
return "@@pip//" + _clean_name(name) + ":data"
return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
if _bzlmod:
return "@@pip//:" + _clean_name(name) + "_dist_info"
return "@@pip//" + _clean_name(name) + ":dist_info"
return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down
35 changes: 21 additions & 14 deletions python/pip_install/pip_repository.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
"""
requirements = parse_requirements(rctx.read(requirements_txt)).requirements

build_content = ""
for requirement in requirements:
build_content += """\
name = _clean_pkg_name(requirement[0])
build_content = """
alias(
name = "{name}",
actual = ":pkg",
visibility = ["//visibility:public"],
)

alias(
name = "{name}_pkg",
name = "pkg",
actual = "@{repo_prefix}{dep}//:pkg",
visibility = ["//visibility:public"],
)

alias(
name = "{name}_whl",
name = "whl",
actual = "@{repo_prefix}{dep}//:whl",
visibility = ["//visibility:public"],
)

alias(
name = "{name}_data",
name = "data",
actual = "@{repo_prefix}{dep}//:data",
visibility = ["//visibility:public"],
)

alias(
name = "{name}_dist_info",
name = "dist_info",
actual = "@{repo_prefix}{dep}//:dist_info",
visibility = ["//visibility:public"],
)
""".format(
name = _clean_pkg_name(requirement[0]),
name = name,
repo_prefix = rctx.attr.repo_prefix,
dep = _clean_pkg_name(requirement[0]),
dep = name,
)

return build_content
rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

# We need a BUILD file to load the generated requirements.bzl
build_contents = _BUILD_FILE_CONTENTS

if rctx.attr.bzlmod:
build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
# Generate aliases for better usability
_bzlmod_pkg_aliases(rctx, requirements_txt)

return

Expand Down
32 changes: 22 additions & 10 deletions python/pip_install/tools/lib/bazel.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
if bzlmod:
return '"@{}//{}:{}"'.format(
repo_prefix[:-1],
sanitise_name(whl_name, prefix=""),
label,
)

return '"@{}//:{}"'.format(
sanitise_name(whl_name, prefix=repo_prefix),
label,
)


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
_whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
)
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
_whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
)
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)
17 changes: 11 additions & 6 deletions python/pip_install/tools/lock_file_generator/lock_file_generator.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

all_requirements = ", ".join(
[
bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
bazel.sanitised_repo_library_label(
ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
)
for ir, _ in install_req_and_lines
]
)

all_whl_requirements = ", ".join(
[
bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
bazel.sanitised_repo_file_label(
ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
)
for ir, _ in install_req_and_lines
]
)
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

def requirement(name):
if _bzlmod:
return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

def whl_requirement(name):
if _bzlmod:
return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

def data_requirement(name):
if _bzlmod:
return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
return "@@{repo}//" + _clean_name(name) + ":{data_label}"
return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

def dist_info_requirement(name):
if _bzlmod:
return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

def entry_point(pkg, script = None):
Expand Down
131 changes: 103 additions & 28 deletions python/pip_install/tools/lock_file_generator/lock_file_generator_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
)
args = argparse.Namespace()
args.requirements_lock = str(requirements_lock.resolve())
args.repo = ("pip_parsed_deps_pypi__",)
args.repo_prefix = "pip_parsed_deps_pypi__"
args.repo = ("pip_parsed_deps",)
args.repo_prefix = "pip_parsed_deps_"
extra_pip_args = ["--index-url=pypi.org/simple"]
pip_data_exclude = ["**.foo"]
args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
repo_prefix=args.repo_prefix,
whl_library_args=whl_library_args,
)
library_target = "@pip_parsed_deps_pypi__foo//:pkg"
whl_target = "@pip_parsed_deps_pypi__foo//:whl"
all_requirements = 'all_requirements = ["{library_target}"]'.format(
library_target=library_target
)
all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
whl_target=whl_target
)
self.assertIn(all_requirements, contents, contents)
self.assertIn(all_whl_requirements, contents, contents)
self.assertIn(requirement_string, contents, contents)
all_flags = extra_pip_args + ["--require-hashes", "True"]
self.assertIn(
"'extra_pip_args': {}".format(repr(all_flags)), contents, contents
)
self.assertIn(
"'pip_data_exclude': {}".format(repr(pip_data_exclude)),
contents,
contents,

# Assert
library_target = "@pip_parsed_deps_foo//:pkg"
whl_target = "@pip_parsed_deps_foo//:whl"
all_requirements = 'all_requirements = ["{library_target}"]'.format(
library_target=library_target
)
all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
whl_target=whl_target
)
self.assertIn(all_requirements, contents, contents)
self.assertIn(all_whl_requirements, contents, contents)
self.assertIn("_bzlmod = False", contents, contents)
self.assertIn(requirement_string, contents, contents)
all_flags = extra_pip_args + ["--require-hashes", "True"]
self.assertIn(
"'extra_pip_args': {}".format(repr(all_flags)), contents, contents
)
self.assertIn(
"'pip_data_exclude': {}".format(repr(pip_data_exclude)),
contents,
contents,
)
self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
self.assertIn(
"'python_interpreter_target': '@custom_python//:exec'",
contents,
contents,
)
# Assert it gets set to an empty dict by default.
self.assertIn("'environment': {}", contents, contents)
self.assertIn(
"def install_deps(**whl_library_kwargs)",
contents,
contents,
)

def test_generated_requirements_bzl_bzlmod(self) -> None:
with tempfile.TemporaryDirectory() as temp_dir:
requirements_lock = Path(temp_dir) / "requirements.txt"
comments_and_flags = "#comment\n--require-hashes True\n"
requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
requirements_lock.write_bytes(
bytes(comments_and_flags + requirement_string, encoding="utf-8")
)
self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
self.assertIn(
"'python_interpreter_target': '@custom_python//:exec'",
contents,
contents,

extra_pip_args = ["--index-url=pypi.org/simple"]
pip_data_exclude = ["**.foo"]

args = argparse.Namespace()
args.requirements_lock = str(requirements_lock.resolve())
args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
args.repo_prefix = "pip_parsed_deps_"
args.extra_pip_args = json.dumps({"arg": extra_pip_args})
args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
args.python_interpreter = "/custom/python3"
args.python_interpreter_target = "@custom_python//:exec"
args.environment = json.dumps({"arg": {}})
whl_library_args = lock_file_generator.parse_whl_library_args(args)

contents = lock_file_generator.generate_parsed_requirements_contents(
requirements_lock=args.requirements_lock,
repo=args.repo,
repo_prefix=args.repo_prefix,
whl_library_args=whl_library_args,
bzlmod=True,
)
# Assert it gets set to an empty dict by default.
self.assertIn("'environment': {}", contents, contents)

# Assert
library_target = "@pip_parsed_deps//foo:pkg"
whl_target = "@pip_parsed_deps//foo:whl"
all_requirements = 'all_requirements = ["{library_target}"]'.format(
library_target=library_target
)
all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
whl_target=whl_target
)
self.assertIn(all_requirements, contents, contents)
self.assertIn(all_whl_requirements, contents, contents)
self.assertIn("_bzlmod = True", contents, contents)
self.assertIn(requirement_string, contents, contents)
all_flags = extra_pip_args + ["--require-hashes", "True"]
self.assertIn(
"'extra_pip_args': {}".format(repr(all_flags)), contents, contents
)
self.assertIn(
"'pip_data_exclude': {}".format(repr(pip_data_exclude)),
contents,
contents,
)
self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
self.assertIn(
"'python_interpreter_target': '@custom_python//:exec'",
contents,
contents,
)
# Assert it gets set to an empty dict by default.
self.assertIn("'environment': {}", contents, contents)
self.assertNotIn(
"def install_deps(**whl_library_kwargs)",
contents,
contents,
)

def test_parse_install_requirements_with_args(self):
# Test requirements files with varying arguments
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays#966

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

aignas
wants to merge
4
commits into

from

 Closed


feat(pip_parse)!: use user friendly aliases to pip repos in requirements arrays
#966
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fbe64c0

feat: Store alias labels in requirements arrays if using bzlmod


aignas Jan 3, 2023
bddd80f

feat!: generate user friendly aliases for everyone


aignas Jan 27, 2023
223ca49

fixup: update the requirements vendoring example


aignas Jan 27, 2023
fc4c5fa

fixup: unit tests after a rebase


aignas Jan 27, 2023

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


3 changes: 2 additions & 1 deletion
examples/bzlmod/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ py_library(
 name = "lib",
 srcs = ["__init__.py"],
 deps = [
 requirement("pylint"),
 # You can reference libraries using plain text form or the 'requirement' macro
 "@pip//pylint",
 requirement("tabulate"),
 requirement("python-dateutil"),
 ],
Expand Down

8 changes: 4 additions & 4 deletions
examples/pip_parse_vendored/requirements.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,22 +21,22 @@ def _clean_name(name):

def requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_pkg"
 return "@@pip//" + _clean_name(name) + ":pkg"
 return "@pip_" + _clean_name(name) + "//:pkg"

def whl_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_whl"
 return "@@pip//" + _clean_name(name) + ":whl"
 return "@pip_" + _clean_name(name) + "//:whl"

def data_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_data"
 return "@@pip//" + _clean_name(name) + ":data"
 return "@pip_" + _clean_name(name) + "//:data"

def dist_info_requirement(name):
 if _bzlmod:
 return "@@pip//:" + _clean_name(name) + "_dist_info"
 return "@@pip//" + _clean_name(name) + ":dist_info"
 return "@pip_" + _clean_name(name) + "//:dist_info"

def entry_point(pkg, script = None):
Expand Down

35 changes: 21 additions & 14 deletions
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,36 +264,45 @@ def _bzlmod_pkg_aliases(rctx, requirements_txt):
 """
 requirements = parse_requirements(rctx.read(requirements_txt)).requirements

 build_content = ""
 for requirement in requirements:
 build_content += """\
 name = _clean_pkg_name(requirement[0])
 build_content = """
alias(
 name = "{name}",
 actual = ":pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_pkg",
 name = "pkg",
 actual = "@{repo_prefix}{dep}//:pkg",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_whl",
 name = "whl",
 actual = "@{repo_prefix}{dep}//:whl",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_data",
 name = "data",
 actual = "@{repo_prefix}{dep}//:data",
 visibility = ["//visibility:public"],
)

alias(
 name = "{name}_dist_info",
 name = "dist_info",
 actual = "@{repo_prefix}{dep}//:dist_info",
 visibility = ["//visibility:public"],
)
""".format(
 name = _clean_pkg_name(requirement[0]),
 name = name,
 repo_prefix = rctx.attr.repo_prefix,
 dep = _clean_pkg_name(requirement[0]),
 dep = name,
 )

return build_content
 rctx.file("{}/BUILD.bazel".format(name), build_content)

def _pip_repository_impl(rctx):
 python_interpreter = _resolve_python_interpreter(rctx)
Expand DownExpand Up@@ -345,12 +354,10 @@ def _pip_repository_impl(rctx):
 fail("rules_python failed: %s (%s)" % (result.stdout, result.stderr))

 # We need a BUILD file to load the generated requirements.bzl
 build_contents = _BUILD_FILE_CONTENTS

 if rctx.attr.bzlmod:
 build_contents += _bzlmod_pkg_aliases(rctx, requirements_txt)
 rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))

 rctx.file("BUILD.bazel", build_contents + "\n# The requirements.bzl file was generated by running:\n# " + " ".join([str(a) for a in args]))
 # Generate aliases for better usability
 _bzlmod_pkg_aliases(rctx, requirements_txt)

 return

Expand Down

32 changes: 22 additions & 10 deletions
python/pip_install/tools/lib/bazel.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,17 +25,29 @@ def sanitise_name(name: str, prefix: str) -> str:
 return prefix + name.replace("-", "_").replace(".", "_").lower()


def _whl_name_to_repo_root(whl_name: str, repo_prefix: str) -> str:
 return "@{}//".format(sanitise_name(whl_name, prefix=repo_prefix))
def _sanitized_label(
 whl_name: str, repo_prefix: str, label: str, bzlmod: bool = False
) -> str:
 if bzlmod:
 return '"@{}//{}:{}"'.format(
 repo_prefix[:-1],
 sanitise_name(whl_name, prefix=""),
 label,
 )

 return '"@{}//:{}"'.format(
 sanitise_name(whl_name, prefix=repo_prefix),
 label,
 )


def sanitised_repo_library_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), PY_LIBRARY_LABEL
 )
def sanitised_repo_library_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, PY_LIBRARY_LABEL, bzlmod=bzlmod)


def sanitised_repo_file_label(whl_name: str, repo_prefix: str) -> str:
return '"{}:{}"'.format(
 _whl_name_to_repo_root(whl_name, repo_prefix), WHEEL_FILE_LABEL
 )
def sanitised_repo_file_label(
whl_name: str, repo_prefix: str, bzlmod: bool = False
) -> str:
return _sanitized_label(whl_name, repo_prefix, WHEEL_FILE_LABEL, bzlmod=bzlmod)

17 changes: 11 additions & 6 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -117,13 +117,18 @@ def generate_parsed_requirements_contents(

 all_requirements = ", ".join(
 [
 bazel.sanitised_repo_library_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_library_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )

 all_whl_requirements = ", ".join(
 [
 bazel.sanitised_repo_file_label(ir.name, repo_prefix=repo_prefix)
 bazel.sanitised_repo_file_label(
 ir.name, repo_prefix=repo_prefix, bzlmod=bzlmod
 )
 for ir, _ in install_req_and_lines
 ]
 )
Expand DownExpand Up@@ -160,22 +165,22 @@ def _clean_name(name):

 def requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{py_library_label}"
 return "@@{repo}//" + _clean_name(name) + ":{py_library_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{py_library_label}"

 def whl_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{wheel_file_label}"
 return "@@{repo}//" + _clean_name(name) + ":{wheel_file_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{wheel_file_label}"

 def data_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{data_label}"
 return "@@{repo}//" + _clean_name(name) + ":{data_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{data_label}"

 def dist_info_requirement(name):
 if _bzlmod:
 return "@@{repo}//:" + _clean_name(name) + "_{dist_info_label}"
 return "@@{repo}//" + _clean_name(name) + ":{dist_info_label}"
 return "@{repo_prefix}" + _clean_name(name) + "//:{dist_info_label}"

 def entry_point(pkg, script = None):
Expand Down

131 changes: 103 additions & 28 deletions
python/pip_install/tools/lock_file_generator/lock_file_generator_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,8 @@ def test_generated_requirements_bzl(self) -> None:
 )
 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("pip_parsed_deps_pypi__",)
 args.repo_prefix = "pip_parsed_deps_pypi__"
 args.repo = ("pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
Expand All@@ -39,34 +39,109 @@ def test_generated_requirements_bzl(self) -> None:
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 )
 library_target = "@pip_parsed_deps_pypi__foo//:pkg"
 whl_target = "@pip_parsed_deps_pypi__foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,

 # Assert
 library_target = "@pip_parsed_deps_foo//:pkg"
 whl_target = "@pip_parsed_deps_foo//:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = False", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_generated_requirements_bzl_bzlmod(self) -> None:
 with tempfile.TemporaryDirectory() as temp_dir:
 requirements_lock = Path(temp_dir) / "requirements.txt"
 comments_and_flags = "#comment\n--require-hashes True\n"
 requirement_string = "foo==0.0.0 --hash=sha256:hashofFoowhl"
 requirements_lock.write_bytes(
 bytes(comments_and_flags + requirement_string, encoding="utf-8")
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,

 extra_pip_args = ["--index-url=pypi.org/simple"]
 pip_data_exclude = ["**.foo"]

 args = argparse.Namespace()
 args.requirements_lock = str(requirements_lock.resolve())
 args.repo = ("rules_python~override~pip_parsed_deps~pip_parsed_deps",)
 args.repo_prefix = "pip_parsed_deps_"
 args.extra_pip_args = json.dumps({"arg": extra_pip_args})
 args.pip_data_exclude = json.dumps({"arg": pip_data_exclude})
 args.python_interpreter = "/custom/python3"
 args.python_interpreter_target = "@custom_python//:exec"
 args.environment = json.dumps({"arg": {}})
 whl_library_args = lock_file_generator.parse_whl_library_args(args)

 contents = lock_file_generator.generate_parsed_requirements_contents(
 requirements_lock=args.requirements_lock,
 repo=args.repo,
 repo_prefix=args.repo_prefix,
 whl_library_args=whl_library_args,
 bzlmod=True,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)

 # Assert
 library_target = "@pip_parsed_deps//foo:pkg"
 whl_target = "@pip_parsed_deps//foo:whl"
 all_requirements = 'all_requirements = ["{library_target}"]'.format(
 library_target=library_target
 )
 all_whl_requirements = 'all_whl_requirements = ["{whl_target}"]'.format(
 whl_target=whl_target
 )
 self.assertIn(all_requirements, contents, contents)
 self.assertIn(all_whl_requirements, contents, contents)
 self.assertIn("_bzlmod = True", contents, contents)
 self.assertIn(requirement_string, contents, contents)
 all_flags = extra_pip_args + ["--require-hashes", "True"]
 self.assertIn(
 "'extra_pip_args': {}".format(repr(all_flags)), contents, contents
 )
 self.assertIn(
 "'pip_data_exclude': {}".format(repr(pip_data_exclude)),
 contents,
 contents,
 )
 self.assertIn("'python_interpreter': '/custom/python3'", contents, contents)
 self.assertIn(
 "'python_interpreter_target': '@custom_python//:exec'",
 contents,
 contents,
 )
 # Assert it gets set to an empty dict by default.
 self.assertIn("'environment': {}", contents, contents)
 self.assertNotIn(
 "def install_deps(**whl_library_kwargs)",
 contents,
 contents,
 )

 def test_parse_install_requirements_with_args(self):
 # Test requirements files with varying arguments
Expand Down