-
-
Save lamchau/1c006ea0ca274da739e82f0a6ad220ea to your computer and use it in GitHub Desktop.
Using a decorator to simplify subcommand creation with argparse
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
from argparse import ArgumentParser | |
cli = ArgumentParser() | |
subparsers = cli.add_subparsers(dest="subcommand") | |
def argument(*name_or_flags, **kwargs): | |
"""Convenience function to properly format arguments to pass to the | |
subcommand decorator. | |
""" | |
return (list(name_or_flags), kwargs) | |
def subcommand(args=[], parent=subparsers): | |
"""Decorator to define a new subcommand in a sanity-preserving way. | |
The function will be stored in the ``func`` variable when the parser | |
parses arguments so that it can be called directly like so:: | |
args = cli.parse_args() | |
args.func(args) | |
Usage example:: | |
@subcommand([argument("-d", help="Enable debug mode", action="store_true")]) | |
def subcommand(args): | |
print(args) | |
Then on the command line:: | |
$ python cli.py subcommand -d | |
""" | |
def decorator(func): | |
parser = parent.add_parser(func.__name__, description=func.__doc__) | |
for arg in args: | |
parser.add_argument(*arg[0], **arg[1]) | |
parser.set_defaults(func=func) | |
return decorator | |
@subcommand() | |
def nothing(args): | |
print("Nothing special!") | |
@subcommand([argument("-d", help="Debug mode", action="store_true")]) | |
def test(args): | |
print(args) | |
@subcommand([argument("-f", "--filename", help="A thing with a filename")]) | |
def filename(args): | |
print(args.filename) | |
@subcommand([argument("name", help="Name")]) | |
def name(args): | |
print(args.name) | |
if __name__ == "__main__": | |
args = cli.parse_args() | |
if args.subcommand is None: | |
cli.print_help() | |
else: | |
args.func(args) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment