t.w.t.Options(usage.Options) : class documentation

Part of twisted.web2.tap View Source View In Hierarchy

No class docstring
Method __init__ Undocumented
Method opt_index Add the name of a file used to check for directory indexes.
Method opt_path A path that will be used to serve the root resource as a raw file
Method opt_processor `ext=class' where `class' is added as a Processor for files ending
Method opt_class A class that will be used to serve the root resource. Must implement twisted.web2.iweb.IResource and take no arguments.
Method opt_allow_ignore_ext Specify whether or not a request for 'foo' should return 'foo.ext'
Method opt_ignore_ext Specify an extension to ignore. These will be processed in order.
Method opt_mimetype Mapping from file extension to MIME Type in the form of 'ext=type'.
Method opt_vhost_path Specify a directory to use for automatic named virtual hosts.
Method opt_vhost_static Specify a virtual host in the form of domain=path to be served as
Method opt_vhost_class Specify a virtual host in the form of domain=class,
Method postOptions I am called after the options are parsed.

Inherited from Options:

Method __hash__ Define a custom hash function so that Options instances can be used
Method opt_help Display this help and exit.
Method opt_version Undocumented
Method parseOptions The guts of the command-line parser.
Method parseArgs I am called with any leftover arguments which were not options.
Method __str__ Undocumented
Method getSynopsis Returns a string containing a description of these options and how to
Method getUsage Undocumented
Method _generic_flag Undocumented
Method _gather_flags Gather up boolean (flag) options.
Method _gather_parameters Gather options which take a value.
Method _gather_handlers Gather up options with their own handler methods.
def __init__(self): (source)
overrides twisted.python.usage.Options.__init__
Undocumented
def opt_index(self, indexName): (source)
Add the name of a file used to check for directory indexes. [default: index, index.html]
def opt_path(self, path): (source)
A path that will be used to serve the root resource as a raw file or directory.
def opt_processor(self, proc): (source)
`ext=class' where `class' is added as a Processor for files ending with `ext'.
def opt_class(self, className): (source)
A class that will be used to serve the root resource. Must implement twisted.web2.iweb.IResource and take no arguments.
def opt_allow_ignore_ext(self): (source)
Specify whether or not a request for 'foo' should return 'foo.ext'
def opt_ignore_ext(self, ext): (source)
Specify an extension to ignore. These will be processed in order.
def opt_mimetype(self, mimetype): (source)
Mapping from file extension to MIME Type in the form of 'ext=type'. Example: html=text/html
def opt_vhost_path(self, path): (source)
Specify a directory to use for automatic named virtual hosts. It is assumed that this directory contains a series of subdirectories each representing a virtual host domain name and containing the files to be served at that domain.
def opt_vhost_static(self, virtualHost): (source)
Specify a virtual host in the form of domain=path to be served as raw directory or file.
def opt_vhost_class(self, virtualHost): (source)
Specify a virtual host in the form of domain=class, where class can be adapted to an iweb.IResource and has a zero-argument constructor.
def postOptions(self): (source)
overrides twisted.python.usage.Options.postOptions
I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.

API Documentation for Twisted, generated by pydoctor at 2010-07-05 15:03:32.