[internal] Add infrastructure to deprecate target names #13164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust] # Building wheels and fs_util will be skipped. Delete if not intended. [ci skip-build-wheels]
stuhood
approved these changes
Oct 8, 2021
Eric-Arellano
added a commit
that referenced
this pull request
Oct 10, 2021
…t` (#13133) As articulated in the [target generator proposal](https://docs.google.com/document/d/1HpJn2jTWf5sKob6zhe4SqHZ7KWBlX4a6OJOwnuw-IHo/edit), Pants builds are made up of targets representing the "atom"s of the language, like a single `python_test` file vs. a `go_package` directory. In Python, the atom is a single requirement, like `Django`. Technically, we let you put multiple requirements into a `python_requirement_library`. But it's intended that the requirements string are for the same project, and it's meant to accommodate `Django==2 ; sys_version<3 && Django==3 ; sys_version>3`. Our macros already conform to that usage. If you want to relate two different projects—such as that you need `setuptools` for a particular requirement to build—you should use the `dependencies` field. So, renaming to `python_requirement`: 1. Better captures that it refers to a single external project, 2. Avoids confusion with what a "library" means, and 3. Is less verbose. -- This adds a script `rename_targets_pants28.py` to automate fixing BUILD files for users. It's not done via tailor because this script is one-time and throw-away. ## Impact on `./pants peek` The targets generated by macros like `python_requirements` will now report the `target_type` as `python_requirement`. There's no graceful way to handle that deprecation: we can't have `./pants peek` claim it has two target names. ## No impact on `./pants filter --target-type` Thanks to #13164, you can safely use either the new name or old name. [ci skip-rust] [ci skip-build-wheels]
Merged
kaos
added a commit
that referenced
this pull request
Nov 26, 2021
) Inspired by #13164 Pre-work for renaming the `pypi_repositories` field to `repositories` for `python_distribution` targets.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows us to have two aliases refer back to the same target type. This means that
./pants filter --target-typewill work the same as before. Target generation will also work the same, which matches an exact target type, rather than being field-based like most of the Target API.Example:
[ci skip-rust]
[ci skip-build-wheels]