Arbitrary CLI args for shell tasks #66
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
The parameters specified in the yaml corresponding to specific task plugins file are now passed to their corresponding classes in core. ShellTask and IconTask. For that pydantic discrimantors are used. See for more information https://docs.pydantic.dev/latest/concepts/unions/#discriminated-unions-with-callable-discriminator To test the new changes formatting of represented member variables has been added to the formatting of `core.Task` objects. Documentation to the `core.Plugin` has been added and the class has been renamed to `core.TaskPlugin`.
GeigerJ2
force-pushed
the
feature/49/shell-args
branch
from
55cb807 to
3b87663
Compare
GeigerJ2
force-pushed
the
feature/49/shell-args
branch
from
c472563 to
9f52a76
Compare
GeigerJ2
changed the title
leclairm
reviewed
Dec 17, 2024
At some point, we might have to differentiate between pretty printing for users and for serialized test data. For now, I'd say we keep it his way as testing is more important. Later we could work on stg like a verbosity level and other pretty printing options for users as opposed to testing. |
|
Thanks for the quick review, @leclairm! I addressed your points. For the idea of specifying flags as keywords without values, maybe we can keep that in mind for the future, and advance as is for now? I'd like to continue with the WorkGraph creation this afternoon, so that these CLI arguments actually get resolved to something meaningful. So it would be nice to get this merged before.
Fully agree! |
Keep it ince as positional argument.
All good then |
leclairm
approved these changes
Dec 17, 2024
GeigerJ2
added a commit
that referenced
this pull request
Dec 17, 2024
This PR adds the `_CliArgsBaseModel` class (inspired from `_WhenBaseModel`), which replaces the `command_option` and `input_arg_options` of the `ConfigShellTaskSpecs`. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with `-` or `--`. The three test YAML files are updated accordingly, leading to changes in the pretty-print test text files, which is also part of the PR. Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged.
agoscinski
added a commit
that referenced
this pull request
Dec 30, 2024
TODO remove expandvars hack, use by default local folder TODO remove example reference from tests Arbitrary CLI args for shell tasks (#66) This PR adds the `_CliArgsBaseModel` class (inspired from `_WhenBaseModel`), which replaces the `command_option` and `input_arg_options` of the `ConfigShellTaskSpecs`. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with `-` or `--`. The three test YAML files are updated accordingly, leading to changes in the pretty-print test text files, which is also part of the PR. Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged. Fix svgs being created in main directory. (#67) Create `svg` files in subdirectory under `tests/files/svgs` instead of top-level directory, and ignore them via `.gitignore`, while syncing the `svgs` directory. Merge remote-tracking branch 'origin/main' into workgraph --- Pass single argument string to `ShellTasks` (#72) * Try to make current example YAML files run through. * Update class names after rebase/merge * Add `no_icon` config file * First working version apart from flags. * Try fixing argument format. * Current state before branch-off. * Pass one multi-line string as `cli_argument` * Cleanup. * Pass arguments as list. * Remove `workgraph-dev.py` dev file. * Fix issues from `hatch fmt` reimplementing cli_arguments change to unspecified inputs are added as positional cli args automatically delete examples add files required to run the workflow remove old files use rootdir from config move files to confi folder adapt configs to relativ to config folder rm expandvars fix hatch fmt fix hatch fmt update reference rm comment
agoscinski
added a commit
that referenced
this pull request
Dec 30, 2024
TODO remove expandvars hack, use by default local folder TODO remove example reference from tests Arbitrary CLI args for shell tasks (#66) This PR adds the `_CliArgsBaseModel` class (inspired from `_WhenBaseModel`), which replaces the `command_option` and `input_arg_options` of the `ConfigShellTaskSpecs`. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with `-` or `--`. The three test YAML files are updated accordingly, leading to changes in the pretty-print test text files, which is also part of the PR. Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged. Fix svgs being created in main directory. (#67) Create `svg` files in subdirectory under `tests/files/svgs` instead of top-level directory, and ignore them via `.gitignore`, while syncing the `svgs` directory. Merge remote-tracking branch 'origin/main' into workgraph --- Pass single argument string to `ShellTasks` (#72) * Try to make current example YAML files run through. * Update class names after rebase/merge * Add `no_icon` config file * First working version apart from flags. * Try fixing argument format. * Current state before branch-off. * Pass one multi-line string as `cli_argument` * Cleanup. * Pass arguments as list. * Remove `workgraph-dev.py` dev file. * Fix issues from `hatch fmt` reimplementing cli_arguments change to unspecified inputs are added as positional cli args automatically delete examples add files required to run the workflow remove old files use rootdir from config move files to confi folder adapt configs to relativ to config folder rm expandvars fix hatch fmt fix hatch fmt update reference rm comment
agoscinski
added a commit
that referenced
this pull request
Dec 31, 2024
TODO remove expandvars hack, use by default local folder TODO remove example reference from tests Arbitrary CLI args for shell tasks (#66) This PR adds the `_CliArgsBaseModel` class (inspired from `_WhenBaseModel`), which replaces the `command_option` and `input_arg_options` of the `ConfigShellTaskSpecs`. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with `-` or `--`. The three test YAML files are updated accordingly, leading to changes in the pretty-print test text files, which is also part of the PR. Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged. Fix svgs being created in main directory. (#67) Create `svg` files in subdirectory under `tests/files/svgs` instead of top-level directory, and ignore them via `.gitignore`, while syncing the `svgs` directory. Merge remote-tracking branch 'origin/main' into workgraph --- Pass single argument string to `ShellTasks` (#72) * Try to make current example YAML files run through. * Update class names after rebase/merge * Add `no_icon` config file * First working version apart from flags. * Try fixing argument format. * Current state before branch-off. * Pass one multi-line string as `cli_argument` * Cleanup. * Pass arguments as list. * Remove `workgraph-dev.py` dev file. * Fix issues from `hatch fmt` reimplementing cli_arguments change to unspecified inputs are added as positional cli args automatically delete examples add files required to run the workflow remove old files use rootdir from config move files to confi folder adapt configs to relativ to config folder rm expandvars fix hatch fmt fix hatch fmt update reference rm comment implement wait_on clean up code clean up add doc
agoscinski
added a commit
that referenced
this pull request
Jan 1, 2025
TODO remove expandvars hack, use by default local folder TODO remove example reference from tests Arbitrary CLI args for shell tasks (#66) This PR adds the `_CliArgsBaseModel` class (inspired from `_WhenBaseModel`), which replaces the `command_option` and `input_arg_options` of the `ConfigShellTaskSpecs`. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with `-` or `--`. The three test YAML files are updated accordingly, leading to changes in the pretty-print test text files, which is also part of the PR. Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged. Fix svgs being created in main directory. (#67) Create `svg` files in subdirectory under `tests/files/svgs` instead of top-level directory, and ignore them via `.gitignore`, while syncing the `svgs` directory. Merge remote-tracking branch 'origin/main' into workgraph --- Pass single argument string to `ShellTasks` (#72) * Try to make current example YAML files run through. * Update class names after rebase/merge * Add `no_icon` config file * First working version apart from flags. * Try fixing argument format. * Current state before branch-off. * Pass one multi-line string as `cli_argument` * Cleanup. * Pass arguments as list. * Remove `workgraph-dev.py` dev file. * Fix issues from `hatch fmt` reimplementing cli_arguments change to unspecified inputs are added as positional cli args automatically delete examples add files required to run the workflow remove old files use rootdir from config move files to confi folder adapt configs to relativ to config folder rm expandvars fix hatch fmt fix hatch fmt update reference rm comment implement wait_on clean up code clean up add doc cli parameters update tests test work fix everything
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 PR adds the
_CliArgsBaseModelclass (inspired from_WhenBaseModel), which replaces thecommand_optionandinput_arg_optionsof theConfigShellTaskSpecs. Validation is applied on the correctness of the keyword and positional arguments to ensure they start with-or--.I updated the three test YAML files accordingly. This change led to changes in the pretty-print test text files, which is also part of the PR. @ all: Currently, they all appear on one line. Not sure if formatting should be done nicer here. I saw that the
self.as_blockis only applied for entities of theConfigCycleTask, so I just left the.txtfiles as I got them from running the test and updated them in the PR.Actually making something useful out of these arguments only happens when the WG is created, so will require #45 to be merged.