Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A drop-in replacement for `argparse` dispatching subcommand calls to functions, modules or binaries.

Project description

sources pypi build coverage documentation license

If your parser has less than five subcommands, you can parse them with argparse. If you have more, you still can, but you will get a huge, unreadable code. This module makes this easier by dispatching subcommand calls to functions, modules or binaries.

Examples

Example 1 : Manual definition of subcommands

For instance, consider the following code for mycommand.py:

import sys
from argdispatch import ArgumentParser

def foo(args):
    """A function associated to subcommand `foo`."""
    print("Doing interesting stuff")
    sys.exit(1)

if __name__ == "__main__":
    parser = ArgumentParser()
    subparser = parser.add_subparsers()

    subparser.add_function(foo)
    subparser.add_module("bar")
    subparser.add_executable("baz")

     parser.parse_args()

With this simple code:

  • mycommand.py foo -v --arg=2 is equivalent to the python code foo(['-v', '--arg=2']);
  • mycommand.py bar -v --arg=2 is equivalent to python -m bar -v --arg=2;
  • mycommand.py baz -v --arg=2 is equivalent to baz -v --arg=2.

Then, each function, module or binary does whatever it wants with the arguments.

Example 2 : Automatic definition of subcommands

With programs like git, if a git-foo binary exists, then calling git foo --some=arguments is equivalent to git-foo --some=arguments. The following code, in myprogram.py copies this behaviour:

import sys
from argdispatch import ArgumentParser

if __name__ == "__main__":
    parser = ArgumentParser()
    subparser = parser.add_subparsers()

    subparser.add_submodules("myprogram")
    subparser.add_prefix_executables("myprogram-")

    parser.parse_args()

With this program, given that binary myprogram-foo and python module myprogram.bar.__main__.py exist:

  • myprogram foo -v --arg=2 is equivalent to myprogram-foo -v --arg=2;
  • myprogram bar -v --arg=2 is equivalent to python -m myprogram.bar -v --arg=2.

Documentation

The complete documentation is available on readthedocs.

To compile it from source, download and run:

cd doc && make html

What’s new?

See changelog.

Download and install

  • From sources:

  • From pip:

    pip install argdispatch
    
  • Quick and dirty Debian (and Ubuntu?) package

    This requires stdeb to be installed:

    python3 setup.py --command-packages=stdeb.command bdist_deb
    sudo dpkg -i deb_dist/argdispatch-<VERSION>_all.deb
    

Project details


Release history Release notifications

This version
History Node

1.0.0

History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

History Node

0.1.0b1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
argdispatch-1.0.0-py3-none-any.whl (10.7 kB) Copy SHA256 hash SHA256 Wheel py3 Mar 7, 2018
argdispatch-1.0.0.tar.gz (35.3 kB) Copy SHA256 hash SHA256 Source None Mar 7, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page