tornado::options Namespace Reference

Classes
class	_Mockable
class	_Option
class	Error
class	OptionParser
Functions
def	add_parse_callback
def	define
def	parse_command_line
def	parse_config_file
def	print_help
Variables
tuple	options = OptionParser()

---

Function Documentation

def tornado.options.add_parse_callback

(

callback

)

Adds a parse callback, to be invoked when option parsing is done.

See `OptionParser.add_parse_callback`

Definition at line 544 of file options.py.

def tornado.options.define	(		name,
			default = None,
			type = None,
			help = None,
			metavar = None,
			multiple = False,
			group = None,
			callback = None
	)

Defines an option in the global namespace.

See `OptionParser.define`.

Definition at line 509 of file options.py.

def tornado.options.parse_command_line	(		args = None,
			final = True
	)

Parses global options from the command line.

See `OptionParser.parse_command_line`.

Definition at line 520 of file options.py.

def tornado.options.parse_config_file	(		path,
			final = True
	)

Parses global options from a config file.

See `OptionParser.parse_config_file`.

Definition at line 528 of file options.py.

def tornado.options.print_help

(

file = None

)

Prints all the command line options to stderr (or another file).

See `OptionParser.print_help`.

Definition at line 536 of file options.py.

---

Variable Documentation

tuple tornado::options::options = OptionParser()

Definition at line 502 of file options.py.