DM-2639: {{Standardize primary method names, run/runDataRef, across PipeTasks}} #58
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
PaulPrice
approved these changes
Jul 27, 2018
python/lsst/pipe/base/cmdLineTask.py
Outdated
| @@ -429,6 +429,17 @@ def __call__(self, args): | |||
| exitStatus=exitStatus, | |||
| ) | |||
|
|
|||
| def _runDataRef(self, task, dataRef, kwargs): | |||
There was a problem hiding this comment.
This method needs a docstring.
I suggest naming it runTask.
I'm not a fan of the leading underscore on the name, which tells the user that this very useful method should never be overridden, which I think is a bit much to ask.
There was a problem hiding this comment.
Accepted and changed throughout. This makes the LegacyTaskRunner clearer, as it never called runDataRef().
czwa
force-pushed
the
tickets/DM-2639
branch
3 times, most recently
from
f8b6bcb
to
4d61ffd
Compare
Prepare Tasks for Gen3 PipelineTask conversion by: * Renaming CmdlineTask's entry method to `runDataRef`. The default CmdlineTask.TaskRunner now calls a Task's `runDataRef` method on the parsed command line inputs. `runDataRef` method can take any Gen2 Butler data products. * Renaming CmdlineTasks previous core methods (e.g. assemble, characterize) to `run` when they exist.
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.
Rename methods according to RFC-352.
Fifteen total repositories with changes.