python-argparse-subdec
This is a very simple Python package that allows one to create argparse's subcommands via function decorators.
Usage
Create a SubDec object:
import argparse_subdec
# Create the object to collect subcommands via decorators
sd = argparse_subdec.SubDec()
Now, we can define our subcommands. We define a subcommand by decorating a function with method calls to sd, like below:
@sd.add_argument('--option', default='123')
@sd.add_argument('--another')
def foo(args):
print(f'foo subcommand: --option={args.option!r} and --another={args.another!r}')
You can use any method name that you would use in a subparser. In our example above, we used add_argument, probably most commonly used. When creating the subparsers, sd will replay those calls to the created subparser for the foo subcommand.
In the example below we define a second subcommand, which will be named foo-bar:
@sd.cmd(prefix_chars=':')
@sd.add_argument('positional_arg', type=int)
def foo_bar(args):
print(f'foo-bar subcommand: {args.positional_arg!r}')
Note that we use a special decorator, sd.cmd, which makes sd pass all of its arguments down to add_parser() when creating the subparser for foo-bar.
Once our subcommands are defined, we must call sd.create_parsers() in order to effectively create the subparsers:
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
sd.create_parsers(subparsers)
The following is example of how we would call the subcommands:
args = parser.parse_args(['foo', '--another', 'hello'])
args.fn(args) # The subcommand function is assigned to ``args.fn`` by default
# Outputs: foo subcommand: --option='123' and --another='hello'
For more details about the API, check out the subdec module.
Install
Via pip:
pip install argparse-subdec
634 Dec 22, 2022
29 Dec 6, 2022
10 Aug 1, 2022
364 Jan 8, 2023
1.5k Jan 5, 2023
1.8k Jan 6, 2023
102 Jan 6, 2023
34 Oct 27, 2022
2 Nov 5, 2021
0 Feb 6, 2022
10 May 2, 2022
326 Dec 15, 2022
10.1k Dec 31, 2022
1 Jan 9, 2022
6.4k Jan 5, 2023
11k Dec 30, 2022
419 Dec 26, 2022
55 Dec 27, 2022
10.9k Jan 1, 2023
3 Jan 23, 2022
1 Dec 10, 2022
3 Oct 26, 2022
112 Nov 05, 2022
439 Jan 02, 2023
79 Dec 02, 2022
45 Dec 11, 2022
3 Jul 16, 2022
13 Nov 08, 2022
414 Jan 06, 2023
11 Mar 29, 2022
1 Mar 27, 2022
8 Feb 22, 2022
1 Mar 07, 2022
14 Oct 18, 2022
7.4k Jan 07, 2023
19 Dec 21, 2022
24 Oct 10, 2022
166 Dec 30, 2022
10 Jul 27, 2022