API Reference

class argon.App(*args, **kwds)[source]

Represents command-line applications.

Arguments are passed to argparse.ArgumentParser.

arg(*args, **kwds)

Add an argument.

Arguments are passed to argparse.ArgumentParser.add_argument().

command(name, *args, **kwds)

Add a command.

This method adds a new parser to its subparsers. Arguments are passed to the argparse.ArgumentParser constructor.

parse(args)[source]

Parse arguments.

Returns:a two-tuple (callable, parsed_args)
parse_known(args)[source]

Parse known arguments.

Returns:a three-tuple (callable, parsed_args, unknowns)
run(args)[source]

Run application. Typically app.run(sys.argv[1:]).

Same as:

>>> func, parsed_args = self.parse()
>>> func(parsed_args)
run_known(args)[source]

Run application, allow unknown args.

Same as:

>>> func, parsed_args, unknowns = self.parse_known()
>>> func(parsed_args, unknowns)
sub(name, *args, **kwds)

Add a sub-command group.

This method adds a new parser to its subparsers. Arguments are passed to the argparse.ArgumentParser constructor.

class argon.Sub(parser)[source]

Used for sub-command groups.

arg(*args, **kwds)

Add an argument.

Arguments are passed to argparse.ArgumentParser.add_argument().

command(name, *args, **kwds)[source]

Add a command.

This method adds a new parser to its subparsers. Arguments are passed to the argparse.ArgumentParser constructor.

sub(name, *args, **kwds)[source]

Add a sub-command group.

This method adds a new parser to its subparsers. Arguments are passed to the argparse.ArgumentParser constructor.

class argon.Command(parser)[source]

Used to create commands.

arg(*args, **kwds)

Add an argument.

Arguments are passed to argparse.ArgumentParser.add_argument().

handler(func)[source]

Set handler function for command.

The function must accept a single argument args (output from argparse.ArgumentParser.parse_args()).

Related Topics

This Page