Skip to main content

A simple package for parsing function arguments from the command line

Project description

ParseArgs

A simple, intuitive way to parse command line arguments. Simply make a function, and call parseargs on it.
  • parses data types through annoations (annotations not required for string arguments)
  • parses optional keyword arguments by adding them as optional cli arguments
  • parses positional arguments in a variable called arglist (so don't use that as a keyword!)
  • adds a description of the command by using the signature of the method.

Example

in fun.py:

from parseargs import parseargs



def fun(firstname, lastname:str, number:int = 5):
	print(f"Hello {firstname} {lastname}")
	print(f"Your number is {number}")
	number *= 2
	print(f"Twice your number is {number}")


parseargs(fun)

Now on the command line, you can do:

$ python fun.py ricky bobby --number 5

Notice how it will print out 10. If you remove the annotation declaring the number an int, it will instead print out 55, because it will interpret it as a string.

We can get the method signature with:

$ python fun.py -h
usage: test2.py [-h] [--number NUMBER] arglist arglist

signature = (firstname, lastname: str, number: int = 5)

positional arguments:
  arglist

optional arguments:
  -h, --help       show this help message and exit
  --number NUMBER

Project details


Download files

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

Files for parseargs, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size parseargs-0.0.4-py3-none-any.whl (2.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size parseargs-0.0.4.tar.gz (2.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

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