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.

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

internal(config_settings): make config_setting creation reusable #1750

Merged
merged 23 commits into from
Mar 18, 2024

Conversation

aignas
Copy link
Collaborator

@aignas aignas commented Feb 12, 2024

The PR #1743 explored the idea of creating extra config settings for
each target platform that our toolchain is targetting, however that has
a drawback of not being usable in bzlmod if someone built Python for
a platform that we don't provide a toolchain for and tried to use the
pip.parse machinery with that by providing the
python_interpreter_target. That is a niche usecase, but rules_python
is a core ruleset that should only provide abstractions/helpers that
work in all cases or make it possible to extend things.

This explores a way to decouple the definition of the available
config_settings values and how they are constructed by adding an extra
is_python_config_setting macro, that could be used to declare the
config settings from within the pip.parse hub repo. This makes the
work in #1744 to support whl-only hub repos more self-contained.

Supersedes #1743.

@aignas aignas marked this pull request as ready for review February 12, 2024 09:24
aignas added a commit that referenced this pull request Feb 13, 2024
Copy link
Contributor

@rickeylev rickeylev left a comment

Choose a reason for hiding this comment

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

Sorry, ran out of time, didn't get all the way through.

python/config_settings/BUILD.bazel Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
Copy link
Collaborator Author

@aignas aignas left a comment

Choose a reason for hiding this comment

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

Self review done, @rickeylev, I think this can be reviewed for a second time.

python/config_settings/BUILD.bazel Outdated Show resolved Hide resolved
python/private/config_settings.bzl Show resolved Hide resolved
tests/config_settings/construct_config_settings_tests.bzl Outdated Show resolved Hide resolved
aignas added a commit to aignas/rules_python that referenced this pull request Mar 10, 2024
This is a variant of bazelbuild#1625 and was inspired by bazelbuild#1788. In bazelbuild#1625, we
attempt to parse the simple API HTML files in the same `pip.parse`
extension and it brings the follownig challenges:

* The `pip.parse` cannot be easily use in `isolated` mode and it may
  be difficult to implement the isolation if bazelbuild/bazel#20186
  moves forward.
* Splitting the `pypi_index` out of the `pip.parse` allows us to accept
  the location of the parsed simple API artifacts encoded as a bazel
  label.
* Separation of the logic allows us to very easily implement usage of
  the downloader for cross-platform wheels.
* The `whl` `METADATA` might not be exposed through older versions of
  Artifactory, so having the complexity hidden in this single extension
  allows us to not increase the complexity and scope of `pip.parse` too
  much.
* The repository structure can be reused for `pypi_install` extension
  from bazelbuild#1728.

TODO:
- [ ] Add unit tests for functions in `pypi_index.bzl` bzlmod extension if
  the design looks good.
- [ ] Changelog.

Out of scope of this PR:
- Further usage of the downloaded artifacts to implement something
  similar to bazelbuild#1625 or bazelbuild#1744. This needs bazelbuild#1750 and bazelbuild#1764.
- Making the lock file the same on all platforms - We would need
  to fully parse the requirements file.
- Support for different dependency versions in the `pip.parse` hub repos
  based on each platform - we would need to be able to interpret
  platform markers in some way, but `pypi_index` should be good already.
- Implementing the parsing of METADATA to detect dependency cycles.
- Support for `requirements` files that are not created via
  `pip-compile`.
- Support for other lock formats, though that would be reasonably
  trivial to add.

Open questions:
- Support for VCS dependencies in requirements files - We should
  probably handle them as `overrides` in the `pypi_index` extension and
  treat them in `pip.parse` just as an `sdist`, but I am not sure it
  would work without any issues.
python/config_settings/BUILD.bazel Outdated Show resolved Hide resolved
python/config_settings/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Show resolved Hide resolved
python/config_settings/config_settings.bzl Show resolved Hide resolved
python/config_settings/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Outdated Show resolved Hide resolved
python/private/config_settings.bzl Show resolved Hide resolved
python/private/config_settings.bzl Show resolved Hide resolved
python/private/config_settings.bzl Show resolved Hide resolved
aignas and others added 16 commits March 16, 2024 15:48
The PR #1743 explored the idea of creating extra config settings for
each target platform that our toolchain is targetting, however that has
a drawback of not being usable in `bzlmod` if someone built Python for
a platform that we don't provide a toolchain for and tried to use the
`pip.parse` machinery with that by providing the
`python_interpreter_target`. That is a niche usecase, but `rules_python`
is a core ruleset that should only provide abstractions/helpers that
work in all cases or make it possible to extend things.

This explores a way to decouple the definition of the available
`config_settings` values and how they are constructed by adding an extra
`is_python_config_setting` macro, that could be used to declare the
config settings from within the `pip.parse` hub repo. This makes the
work in #1744 to support whl-only hub repos more self-contained.

Supersedes #1743.
Co-authored-by: Richard Levasseur <rlevasseur@google.com>
@rickeylev rickeylev added this pull request to the merge queue Mar 18, 2024
Merged via the queue into main with commit c9c2768 Mar 18, 2024
7 checks passed
@aignas aignas deleted the refactor/config-settings branch October 17, 2024 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants