cmd_arg and cmd_out syntactic sugar funcs for attrs.field in ShellSpec/ShellOutSpec
#653
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
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #653 +/- ##
==========================================
- Coverage 81.77% 81.76% -0.01%
==========================================
Files 20 21 +1
Lines 4400 4410 +10
Branches 1264 0 -1264
==========================================
+ Hits 3598 3606 +8
- Misses 798 804 +6
+ Partials 4 0 -4
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
|
If you look at the codecov report, the coverage doesn't actually change, so not sure where the -5.07% drop is coming from |
|
See discussion in #647 for background on this PR |
|
do I understand correctly that #655 replaces this one? |
|
Closing until #692 is settled |
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.
Types of changes
Summary
Adds the
pydra.mark.shell_commands.cmd_arg()andpydra.mark.shell_commands.cmd_out()methods to streamline the definition of input/output specs for shell command task definitions. Instead of creating an attrs.field by hand and setting the metadata directly,cmd_argandcmd_outdo this for you.The main benefit is that
cmd_argandcmd_outspecify the valid metadata fields that can be added to the input and output fields, making the code more self-documenting. It also makes the task definitions slightly less verbose.Checklist