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

shell_task decorator #655

Closed
wants to merge 11 commits into from
11 changes: 6 additions & 5 deletions docs/input_spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,9 @@ In the example we used multiple keys in the metadata dictionary including `help_
(a specific input field will be sent).


Validators
----------
Pydra allows for using simple validator for types and `allowev_values`.
The validators are disabled by default, but can be enabled by calling
`pydra.set_input_validator(flag=True)`.
`shell_arg` Function
--------------------

For convenience, there is a function in `pydra.mark` called `shell_arg()`, which will
takes the above metadata values as arguments and inserts them into the metadata passed
to `attrs.field`. This can be especially useful when using an IDE with code-completion.
3 changes: 2 additions & 1 deletion pydra/mark/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from .functions import annotate, task
from .shell import shell_task, shell_arg, shell_out

__all__ = ("annotate", "task")
__all__ = ("annotate", "task", "shell_task", "shell_arg", "shell_out")
Loading