arguments

Argument parser based on docopt

install

pip install arguments

usage

Docopt is used for parsing the docstring (doc), arguments bundles the schema parser and returns a OptionParser like object with normalized attributes

For example

arguments test

Usage:
  tests.py <posarg1> <posarg2>

Options:
  -h --help                     Show this screen.
  -o --option=<option1>         An option.
  --option2=<option2>           An option [default: hello].
  -p --parameter=<parameter>    Folder to check the git repos out [default: 77].
  -v --verbose                  Folder from where to run the command [default: .].

called like

python tests.py pval1 pval2

will when called in python return

>>> myargs = Arguments()
>>> print myargs.posarg1
pyval1

>>> print myargs.posarg2
pyval2

Using schema

Assume you are using docopt with the following usage-pattern:

my_program.py [--count=N] <path> <files>

and you would like to validate that <files> are readable, and that <path> exists, and that --count is either integer from 0 to 5, or None.

this is how you validate it using schema:

>>> from arguments import *

>>> s = Schema({'<files>': [Use(open)],
...             '<path>': os.path.exists,
...             '--count': Or(None, And(Use(int), lambda n: 0 < n < 5))})

>>> args = Arguments(validateschema=s)

>>> args.files
[<open file 'LICENSE-MIT', mode 'r' at 0x...>, <open file 'setup.py', mode 'r' at 0x...>]

>>> args.path
'../'

>>> args.count
3

As you can see, it validated data successfully, opened files and converted '3' to int.

Metadata

Release files for arguments 18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for arguments 18
File	Size	Uploaded
arguments-18.tar.gz	6.5 kB	Mar 6, 2015	Details

Release files / arguments-18.tar.gz

Download URL	arguments-18.tar.gz
Size	6.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`75e4e210402a1ad2c1653130aa47a94711571458e09421f73cca511f74bb318b`
BLAKE2b-256 checksum How to use checksums	`205c06bb21473e75608a58fdee92b8a485b6767e2a3226f7fe724984f1869afa`
Upload date	Mar 6, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No