docopt Namespace Reference

Classes
class	Argument
class	BranchPattern
class	Command
class	Dict
class	DocoptExit
class	DocoptLanguageError
class	Either
class	LeafPattern
class	OneOrMore
class	Option
class	Optional
class	OptionsShortcut
class	Pattern
class	Required
class	Tokens

Functions
	transform (pattern)
	parse_long (tokens, options)
	parse_shorts (tokens, options)
	parse_pattern (source, options)
	parse_expr (tokens, options)
	parse_seq (tokens, options)
	parse_atom (tokens, options)
	parse_argv (tokens, options, options_first=False)
	parse_defaults (doc)
	parse_section (name, source)
	formal_usage (section)
	extras (help, version, options, doc)
	docopt (doc, argv=None, help=True, version=None, options_first=False)

Detailed Description

Pythonic command-line interface parser that will make you smile.

 * http://docopt.org
 * Repository and issue-tracker: https://github.com/docopt/docopt
 * Licensed under terms of MIT license (see LICENSE-MIT)
 * Copyright (c) 2013 Vladimir Keleshev, vladimir@keleshev.com

Function Documentation

docopt()

docopt.docopt	(		doc,
			argv = None,
			help = True,
			version = None,
			options_first = False )

Parse `argv` based on command-line interface described in `doc`.

`docopt` creates your command-line interface based on its
description that you pass as `doc`. Such description can contain
--options, <positional-argument>, commands, which could be
[optional], (required), (mutually | exclusive) or repeated...

Parameters
----------
doc : str
    Description of your command-line interface.
argv : list of str, optional
    Argument vector to be parsed. sys.argv[1:] is used if not
    provided.
help : bool (default: True)
    Set to False to disable automatic help on -h or --help
    options.
version : any object
    If passed, the object will be printed if --version is in
    `argv`.
options_first : bool (default: False)
    Set to True to require options precede positional arguments,
    i.e. to forbid options and positional arguments intermix.

Returns
-------
args : dict
    A dictionary, where keys are names of command-line elements
    such as e.g. "--verbose" and "<path>", and values are the
    parsed values of those elements.

Example
-------
>>> from docopt import docopt
>>> doc = '''
... Usage:
...     my_program tcp <host> <port> [--timeout=<seconds>]
...     my_program serial <port> [--baud=<n>] [--timeout=<seconds>]
...     my_program (-h | --help | --version)
...
... Options:
...     -h, --help  Show this screen and exit.
...     --baud=<n>  Baudrate [default: 9600]
... '''
>>> argv = ['tcp', '127.0.0.1', '80', '--timeout', '30']
>>> docopt(doc, argv)
{'--baud': '9600',
 '--help': False,
 '--timeout': '30',
 '--version': False,
 '<host>': '127.0.0.1',
 '<port>': '80',
 'serial': False,
 'tcp': True}

See also
--------
* For video introduction see http://docopt.org
* Full documentation is available in README.rst as well as online
  at https://github.com/docopt/docopt#readme

parse_argv()

docopt.parse_argv	(		tokens,
			options,
			options_first = False )

Parse command-line argument vector.

If options_first:
    argv ::= [ long | shorts ]* [ argument ]* [ '--' [ argument ]* ] ;
else:
    argv ::= [ long | shorts | argument ]* [ '--' [ argument ]* ] ;

parse_atom()

docopt.parse_atom	(		tokens,
			options )

atom ::= '(' expr ')' | '[' expr ']' | 'options'
         | long | shorts | argument | command ;

parse_expr()

docopt.parse_expr	(		tokens,
			options )

expr ::= seq ( '|' seq )* ;

parse_long()

docopt.parse_long	(		tokens,
			options )

long ::= '--' chars [ ( ' ' | '=' ) chars ] ;

parse_seq()

docopt.parse_seq	(		tokens,
			options )

seq ::= ( atom [ '...' ] )* ;

parse_shorts()

docopt.parse_shorts	(		tokens,
			options )

shorts ::= '-' ( chars )* [ [ ' ' ] chars ] ;

transform()

docopt.transform

(

pattern

)

Expand pattern into an (almost) equivalent one, but with single Either.

Example: ((-a | -b) (-c | -d)) => (-a -c | -a -d | -b -c | -b -d)
Quirks: [-a] => (-a), (-a...) => (-a -a)