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 Apr 04, 2022
19 Aug 24, 2022
1.1k Jan 04, 2023
2 Dec 17, 2021
1 Dec 29, 2021
5 Nov 26, 2022
1 Oct 10, 2021
1 Nov 23, 2021
9 Jul 22, 2022
1 Jan 10, 2022
5 Feb 20, 2022
476 Jan 07, 2023
52 Nov 12, 2022
144 Dec 22, 2022
3 Feb 14, 2022
5 Mar 18, 2022
1 Mar 08, 2022
62 Dec 14, 2022
192 Jan 07, 2023