split out cli validation from execution
A common pattern in our subcommands is to verify the arguments &
options before executing things. For some subcommands, that check
stage is quite long which makes the execution function even bigger.
Lets split that logic out of the execute phase so it's easier to
manage these.
This is most noticeable in the sync subcommand whose Execute func
is quite large, and the option checking makes up ~15% of it.
The manifest command's Execute can be simplified significantly as
the optparse configuration always sets output_file to a string.
Change-Id: I7097847ff040e831345e63de6b467ee17609990e
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/234834
Reviewed-by: David Pursehouse <dpursehouse@collab.net>
Tested-by: Mike Frysinger <vapier@google.com>
diff --git a/command.py b/command.py
index 8c5e246..f7d20a2 100644
--- a/command.py
+++ b/command.py
@@ -98,6 +98,16 @@
self.OptionParser.print_usage()
sys.exit(1)
+ def ValidateOptions(self, opt, args):
+ """Validate the user options & arguments before executing.
+
+ This is meant to help break the code up into logical steps. Some tips:
+ * Use self.OptionParser.error to display CLI related errors.
+ * Adjust opt member defaults as makes sense.
+ * Adjust the args list, but do so inplace so the caller sees updates.
+ * Try to avoid updating self state. Leave that to Execute.
+ """
+
def Execute(self, opt, args):
"""Perform the action, after option parsing is complete.
"""