Rename pip_parse to pip_install#757

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
groodt wants to merge 13 commits into from
Closed

Rename pip_parse to pip_install #757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
eaa3269
.
groodt Jul 14, 2022
b576844
.
groodt Jul 14, 2022
f8505d7
.
groodt Jul 14, 2022
e8ac304
.
groodt Jul 14, 2022
0f1e1fc
.
groodt Jul 14, 2022
a6a3222
.
groodt Jul 14, 2022
d7610c8
.
groodt Jul 14, 2022
45b28fc
.
groodt Jul 14, 2022
b662f67
.
groodt Jul 14, 2022
8c8def1
.
groodt Jul 14, 2022
b9c3e63
.
groodt Jul 14, 2022
0687635
.
groodt Jul 15, 2022
42f8797
Merge branch 'main' into groodt-rename-pip-parse
groodt Aug 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .bazelrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down
87 changes: 24 additions & 63 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
...
python_interpreter_target = interpreter,
...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse`
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
`requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
name = "my_deps",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down
117 changes: 27 additions & 90 deletions docs/pip.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 1 addition & 11 deletions examples/BUILD
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
name = "pip_parse_example",
timeout = "long",
)

bazel_integration_test(
name = "pip_parse_vendored_example",
name = "pip_install_vendored_example",
timeout = "long",
tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
timeout = "long",
)

bazel_integration_test(
name = "relative_requirements_example",
timeout = "long",
)

bazel_integration_test(
name = "bzlmod_example",
)
4 changes: 2 additions & 2 deletions examples/build_file_generation/WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
name = "pip",
requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading
, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading

, '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
Rename pip_parse to pip_install#757

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

groodt
wants to merge
13
commits into

from

 Closed


Rename pip_parse to pip_install
#757
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
eaa3269

.


groodt Jul 14, 2022
b576844

.


groodt Jul 14, 2022
f8505d7

.


groodt Jul 14, 2022
e8ac304

.


groodt Jul 14, 2022
0f1e1fc

.


groodt Jul 14, 2022
a6a3222

.


groodt Jul 14, 2022
d7610c8

.


groodt Jul 14, 2022
45b28fc

.


groodt Jul 14, 2022
b662f67

.


groodt Jul 14, 2022
8c8def1

.


groodt Jul 14, 2022
b9c3e63

.


groodt Jul 14, 2022
0687635

.


groodt Jul 15, 2022
42f8797

Merge branch 'main' into groodt-rename-pip-parse


groodt Aug 13, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_import,examples/relative_requirements,tests/pip_repository_entry_points,tests/pip_deps
build --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/bzlmod,examples/pip_install,examples/pip_install_vendored,examples/pip_repository_annotations,examples/relative_requirements,tests/pip_deps,tests/pip_repository_entry_points

test --test_output=errors

Expand Down

87 changes: 24 additions & 63 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,8 +7,7 @@

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
support in Bazel. It also contains packaging rules for integrating with PyPI
(`pip`). Documentation lives in the
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
[Bazel Build Encyclopedia](https://docs.bazel.build/versions/master/be/python.html).
Expand All@@ -24,7 +23,7 @@ Once they are fully migrated to rules_python, they may evolve at a different
rate, but this repository will still follow
[semantic versioning](https://semver.org).

The packaging rules (`pip_install`, etc.) are less stable. We may make breaking
The package installation rules (`pip_install`, `pip_parse` etc.) are less stable. We may make breaking
changes as they evolve.

This repository is maintained by the Bazel community. Neither Google, nor the
Expand DownExpand Up@@ -69,9 +68,9 @@ python_register_toolchains(

load("@python3_9//:defs.bzl", "interpreter")

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 ...
 python_interpreter_target = interpreter,
 ...
Expand DownExpand Up@@ -101,22 +100,22 @@ py_binary(
)
```

## Using the packaging rules
## Using the package installation rules

Usage of the packaging rules involves two main steps.
Usage of the package installation rules involves two main steps.

1. [Installing `pip` dependencies](#installing-pip-dependencies)
2. [Consuming `pip` dependencies](#consuming-pip-dependencies)
1. [Installing third_party packages](#installing-third_party-packages)
2. [Using third_party packages as dependencies](#using-third_party-packages-as-dependencies)

The packaging rules create two kinds of repositories: A central external repo that holds
The package installation rules create two kinds of repositories: A central external repo that holds
downloaded wheel files, and individual external repos for each wheel's extracted
contents. Users only need to interact with the central external repo; the wheel repos
are essentially an implementation detail. The central external repo provides a
`WORKSPACE` macro to create the wheel repos, as well as a function, `requirement()`, for use in
`BUILD` files that translates a pip package name into the label of a `py_library`
target in the appropriate wheel repo.

### Installing `pip` dependencies
### Installing third_party packages

To add pip dependencies to your `WORKSPACE`, load the `pip_install` function, and call it to create the
central external repo and individual wheel external repos.
Expand All@@ -125,12 +124,17 @@ central external repo and individual wheel external repos.
```python
load("@rules_python//python:pip.bzl", "pip_install")

# Create a central external repo, @my_deps, that contains Bazel targets for all the
# third-party packages specified in the requirements.txt file.
# Create a central repothat knows about the dependencies needed from
# requirements_lock.txt.
pip_install(
 name = "my_deps",
requirements = "//path/to:requirements.txt",
requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

Note that since `pip_install` is a repository rule and therefore executes pip at WORKSPACE-evaluation time, Bazel has no
Expand All@@ -147,41 +151,10 @@ re-executed in order to pick up a non-hermetic change to your environment (e.g.,
updating your system `python` interpreter), you can force it to re-execute by running
`bazel sync --only [pip_install name]`.

### Fetch `pip` dependencies lazily

One pain point with `pip_install` is the need to download all dependencies resolved by
your requirements.txt before the bazel analysis phase can start. For large python monorepos
this can take a long time, especially on slow connections.

`pip_parse` provides a solution to this problem. If you can provide a lock
file of all your python dependencies `pip_parse` will translate each requirement into its own external repository.
Bazel will only fetch/build wheels for the requirements in the subgraph of your build target.
Note: The `pip_parse` rule is deprecated. `pip_install` offers identical functionality and both `pip_parse` 
and `pip_install` now have the same implementation. `pip_parse` will be removed in a future version of the rules

There are API differences between `pip_parse` and `pip_install`:
1. `pip_parse` requires a fully resolved lock file of your python dependencies. You can generate this by using the `compile_pip_requirements` rule,
 running `pip-compile` directly, or using virtualenv and `pip freeze`. `pip_parse` uses a label argument called `requirements_lock` instead of
 `requirements` to make this distinction clear.
2. `pip_parse` translates your requirements into a starlark macro called `install_deps`. You must call this macro in your WORKSPACE to
 declare your dependencies.


```python
load("@rules_python//python:pip.bzl", "pip_parse")

# Create a central repo that knows about the dependencies needed from
# requirements_lock.txt.
pip_parse(
 name = "my_deps",
 requirements_lock = "//path/to:requirements_lock.txt",
)

# Load the starlark macro which will define your dependencies.
load("@my_deps//:requirements.bzl", "install_deps")
# Call it to define repos for your requirements.
install_deps()
```

### Consuming `pip` dependencies
### Using third_party packages as dependencies 

Each extracted wheel repo contains a `py_library` target representing
the wheel's contents. There are two ways to access this library. The
Expand DownExpand Up@@ -217,21 +190,9 @@ labels directly. For `pip_parse` the labels are of the form
@{name}_{package}//:pkg
```

Here `name` is the `name` attribute that was passed to `pip_parse` and
`package` is the pip package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`. If you need to
update `name` from "old" to "new", then you can run the following
buildozer command:

```
buildozer 'substitute deps @old_([^/]+)//:pkg @new_${1}//:pkg' //...:*
```

For `pip_install` the labels are instead of the form

```
@{name}//pypi__{package}
```
Here `name` is the `name` attribute that was passed to `pip_install` and
`package` is the package name with characters that are illegal in
Bazel label names (e.g. `-`, `.`) replaced with `_`.

[requirements-drawbacks]: https://github.com/bazelbuild/rules_python/issues/414

Expand Down

117 changes: 27 additions & 90 deletions
docs/pip.md

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


12 changes: 1 addition & 11 deletions
examples/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,12 +23,7 @@ bazel_integration_test(
)

bazel_integration_test(
 name = "pip_parse_example",
 timeout = "long",
)

bazel_integration_test(
 name = "pip_parse_vendored_example",
 name = "pip_install_vendored_example",
 timeout = "long",
 tags = ["fix-windows"],
)
Expand All@@ -38,11 +33,6 @@ bazel_integration_test(
 timeout = "long",
)

bazel_integration_test(
 name = "relative_requirements_example",
 timeout = "long",
)

bazel_integration_test(
 name = "bzlmod_example",
)

4 changes: 2 additions & 2 deletions
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,9 +48,9 @@ local_repository(
 path = "../..",
)

load("@rules_python//python:pip.bzl", "pip_parse")
load("@rules_python//python:pip.bzl", "pip_install")

pip_parse(
pip_install(
 name = "pip",
 requirements_lock = "//:requirements_lock.txt",
)
Expand Down
Loading