Argument parser based on docopt
install
pip install argumentsusage
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 pval2will when called in python return
>>> myargs = Arguments()
>>> print myargs.posarg1
pyval1
>>> print myargs.posarg2
pyval2Using 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
3As you can see, it validated data successfully, opened files and converted '3' to int.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
arguments-16.tar.gz
(6.6 kB
view details)
File details
Details for the file arguments-16.tar.gz.
File metadata
- Download URL: arguments-16.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0bb59968ea1a6bf9162eb583fbac04ecb087327bdb84440352318a05c8ceb577
|
|
| MD5 |
8a568ea5df1c423c1892991fc337e10d
|
|
| BLAKE2b-256 |
724f94a72e2f20738168a546d4012a9ec89c0b39a7019bf44ae65a4d3cba1e2f
|
