Skip to main content

Add argparser argument based on object heuristics

Project description

This package provides automatic adding of arguments to an argparser. ArgumentParser based on a simple method naming convention.

Basic Usage

Write your class with methods you wish called from a command line starting with a given prefix. Create an ArgparserAdapter, passing your object as a constructor. Methods starting with a the specified prefix, do_ by default, will be added to an argparser via the register call as – arguments. After parsing, call_specified_methods will call methods specified on command. ArgparseAdapter will attempt to convert command line strings to appropriate types if Python type hints are provided.


import argparse
from ipaddress import IPv4Address
from argparser_adapter.argparser_adapter import ArgparserAdapter

class Something:

    def do_seven(self)->int:
        return 7

    def do_double(self,x):
        """double a number"""

    def do_triple(self,x:int):

    def do_sum(self,x:int,y:int):
        """sum arguments"""
        print(x + y)

    def do_ipv4address(self,x:IPv4Address):

def main():
    something = Something()
    adapter = ArgparserAdapter(something)
    parser = argparse.ArgumentParser()
    args = parser.parse_args()

Note the do_double will receive a string and must convert it to an integer. The type hint in do_triple ensures the argument will be an integer.

The resulting argument argparser help is:

usage: [-h]
                     (--double x | --ipv4address x | --seven | --sum x y | --triple x)

optional arguments:
  -h, --help       show this help message and exit
  --double x       double a number
  --ipv4address x
  --sum x y        sum arguments
  --triple x

Docstrings, if present, become help arguments.

Advanced usage

When type conversion fails, the method

def param_conversion_exception(self, e: Exception, method_name: str, parameter_name: str, parameter_type: type,
                               value: str) -> Any:

is called. The default behavior is to raise a ValueError exception including the method and parameter names, the value passed and the original exception message. This method is provided for subclasses to override, if desired. An implementation should raise an Exception or return a suitable parameter for calling method_name.

Alternative packages

More complete packages are available for this purpose, such as Click. This implementation is intended to be simple, lightweight and easy to use.

Project details

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

argparser_adapter-1.4.1-py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page