Skip to content
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

Jump to bottom

docs(pip_parse): Update docs about experimental_requirement_cycles #1588

Merged
merged 1 commit into from
Nov 30, 2023
+12 −10
Merged

docs(pip_parse): Update docs about experimental_requirement_cycles #1588

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ A brief description of the categories of changes:
rules_python Starlark implementation, not the one built into Bazel. NOTE: This
only applies to Bazel 6+; Bazel 5 still uses the builtin implementation.

* (pip_parse) The parameter `experimental_requirement_cycles` may be provided a
map of names to lists of requirements which form a dependency
cycle. `pip_parse` will break the cycle for you transparently. This behavior
is also available under bzlmod as
`pip.parse(experimental_requirement_cycles={})`.

[0.XX.0]: https://github.com/bazelbuild/rules_python/releases/tag/0.XX.0

## [0.27.0] - 2023-11-16
Expand Down Expand Up @@ -59,11 +65,6 @@ A brief description of the categories of changes:
`data`. Note, that the `@pypi_foo//:pkg` labels are still present for
backwards compatibility.

* (pip_parse) The parameter `requirement_cycles` may be provided a map of names
to lists of requirements which form a dependency cycle. `pip_parse` will break
the cycle for you transparently. This behavior is also available under bzlmod
as `pip.parse(requirement_cycles={})`.

* (gazelle) The flag `use_pip_repository_aliases` is now set to `True` by
default, which will cause `gazelle` to change third-party dependency labels
from `@pip_foo//:pkg` to `@pip//foo` by default.
Expand Down
11 changes: 6 additions & 5 deletions docs/sphinx/pypi-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,15 @@ ERROR: .../external/pypi_sphinxcontrib_serializinghtml/BUILD.bazel:44:6: in alia
`-- @pypi_sphinxcontrib_serializinghtml//:pkg (...)
```

The `requirement_cycles` argument allows you to work around these issues by
specifying groups of packages which form cycles. `pip_parse` will transparently
fix the cycles for you and provide the cyclic dependencies simultaneously.
The `experimental_requirement_cycles` argument allows you to work around these
issues by specifying groups of packages which form cycles. `pip_parse` will
transparently fix the cycles for you and provide the cyclic dependencies
simultaneously.

```
pip_parse(
...
requirement_cycles = {
experimental_requirement_cycles = {
"sphinx": [
"sphinx",
"sphinxcontrib-serializinghtml",
Expand All @@ -183,7 +184,7 @@ be a part of the `airflow` cycle. For instance --
```
pip_parse(
...
requirement_cycles = {
experimental_requirement_cycles = {
"airflow": [
"apache-airflow",
"apache-airflow-providers-common-sql",
Expand Down