Extracts backend.adhoc package and backend.experimental.adhoc backend for adhoc_tool
#18237
Conversation
chrisjrn
added
category:user api change
backend: Shell
|
It's definitely worth inspecting commits individually, there's a lot of moving parts, particularly in tests and |
src/python/pants/backend/experimental/adhoc/adhoc_tool_backend_integration_test.py
Show resolved
Hide resolved
| execution_dependencies: tuple[str, ...] | None | ||
| dependencies: tuple[str, ...] | None # can go away after 2.17.0.dev0 per deprecation |
There was a problem hiding this comment.
Should these be the fields instead of the field values?
That would allow using request.execution_dependencies.alias in the _descr string below.
There was a problem hiding this comment.
My goal here was to make adhoc_process_support not depend on any custom field types. Happy to discuss the stylistic merits of it, but you're right, not being able to use .alias is a downside here.
There was a problem hiding this comment.
(this is another request type that will go away when we support scoped dependencies; sigh :))
Co-authored-by: Jacob Floyd <cognifloyd@gmail.com>
Co-authored-by: Jacob Floyd <cognifloyd@gmail.com>
…ackend # Conflicts: # src/python/pants/backend/shell/target_types.py
…kend for `adhoc_tool` (pantsbuild#18237) Per discussion in pantsbuild#18082, this extracts the target formerly known as `experimental_run_in_sandbox`, which is newly named `adhoc_tool`, into a new package at `pants.backend.adhoc`. Registration for `adhoc_tool` is in `pants.backend.experimental.adhoc`, to reflect the non-stable nature of this target type. `adhoc_process_support.py` has been moved to `core.util_rules`: to facilitate this, this file no longer depends on field/target types from the `shell` or `adhoc` backends. This makes for some slightly duplicative code in `adhoc_tool.py` and `shell_command.py`, which should become simpler after we branch for 2.16 (there's some deprecations in there). With this change, we would be in a position to stabilise `shell_command` as-is. --------- Co-authored-by: Jacob Floyd <cognifloyd@gmail.com>
| {AdhocToolArgumentsField.alias}=[""], | ||
| {AdhocToolExecutionDependenciesField.alias}=[":scripts"], | ||
| {AdhocToolOutputDirectoriesField.alias}=["logs/my-script.log"], | ||
| {AdhocToolOutputFilesField.alias}=["results/"], |
There was a problem hiding this comment.
When looking at the rendered docs it was much easier to spot that the example field values here are swapped (files vs directories). 👀
Per discussion in #18082, this extracts the target formerly known as
experimental_run_in_sandbox, which is newly namedadhoc_tool, into a new package atpants.backend.adhoc.Registration for
adhoc_toolis inpants.backend.experimental.adhoc, to reflect the non-stable nature of this target type.adhoc_process_support.pyhas been moved tocore.util_rules: to facilitate this, this file no longer depends on field/target types from theshelloradhocbackends. This makes for some slightly duplicative code inadhoc_tool.pyandshell_command.py, which should become simpler after we branch for 2.16 (there's some deprecations in there).With this change, we would be in a position to stabilise
shell_commandas-is.