Class t.w.t.Options(usage.Options):

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

Define the options accepted by the twistd web plugin.

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
50 Method __init__ Undocumented
55 Method opt_index Add the name of a file used to check for directory indexes.
63 Method opt_user Makes a server with ~/public_html and ~/.twistd-web-pb support for
71 Method opt_path <path> is either a specific file or a directory to be set as the root
89 Method opt_processor `ext=class' where `class' is added as a Processor for files ending
98 Method opt_static Same as --path, this is deprecated and will be removed in a
106 Method opt_class Create a Resource subclass with a zero-argument constructor.
113 Method opt_resource_script An .rpy file to be used as the root resource of the webserver.
118 Method opt_wsgi The FQPN of a WSGI application object to serve as the root resource of
133 Method opt_mime_type Specify the default mime-type for static files.
141 Method opt_allow_ignore_ext Specify whether or not a request for 'foo' should return 'foo.ext'
148 Method opt_ignore_ext Specify an extension to ignore. These will be processed in order.
156 Method opt_flashconduit Start a flashconduit on the specified port.
163 Method postOptions Set up conditional defaults and check for dependencies.

Inherited from Options:

Line # Kind Name Docs
168 Method __hash__ Define a custom hash function so that Options instances can be used
176 Method opt_help Display this help and exit.
183 Method opt_version Undocumented
190 Method parseOptions The guts of the command-line parser.
252 Method parseArgs I am called with any leftover arguments which were not options.
412 Method __str__ Undocumented
415 Method getSynopsis Returns a string containing a description of these options and how to
438 Method getUsage Undocumented
267 Method _generic_flag Undocumented
274 Method _gather_flags Gather up boolean (flag) options.
301 Method _gather_parameters Gather options which take a value.
342 Method _gather_handlers Gather up options with their own handler methods.
Line # Kind Name Docs
168 Method __hash__ Define a custom hash function so that Options instances can be used
50 Method __init__ Undocumented
412 Method __str__ Undocumented
415 Method getSynopsis Returns a string containing a description of these options and how to
438 Method getUsage Undocumented
141 Method opt_allow_ignore_ext Specify whether or not a request for 'foo' should return 'foo.ext'
106 Method opt_class Create a Resource subclass with a zero-argument constructor.
156 Method opt_flashconduit Start a flashconduit on the specified port.
176 Method opt_help Display this help and exit.
148 Method opt_ignore_ext Specify an extension to ignore. These will be processed in order.
55 Method opt_index Add the name of a file used to check for directory indexes.
133 Method opt_mime_type Specify the default mime-type for static files.
71 Method opt_path <path> is either a specific file or a directory to be set as the root
89 Method opt_processor `ext=class' where `class' is added as a Processor for files ending
113 Method opt_resource_script An .rpy file to be used as the root resource of the webserver.
98 Method opt_static Same as --path, this is deprecated and will be removed in a
63 Method opt_user Makes a server with ~/public_html and ~/.twistd-web-pb support for
183 Method opt_version Undocumented
118 Method opt_wsgi The FQPN of a WSGI application object to serve as the root resource of
252 Method parseArgs I am called with any leftover arguments which were not options.
190 Method parseOptions The guts of the command-line parser.
163 Method postOptions Set up conditional defaults and check for dependencies.
274 Method _gather_flags Gather up boolean (flag) options.
342 Method _gather_handlers Gather up options with their own handler methods.
301 Method _gather_parameters Gather options which take a value.
267 Method _generic_flag Undocumented
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_user(self): (source)
Makes a server with ~/public_html and ~/.twistd-web-pb support for users.
def opt_path(self, path): (source)
<path> is either a specific file or a directory to be set as the root of the web server. Use this if you have a directory full of HTML, cgi, php3, epy, or rpy files or any other files that you want to be served up raw.
def opt_processor(self, proc): (source)
`ext=class' where `class' is added as a Processor for files ending with `ext'.
def opt_static(self, path): (source)
Same as --path, this is deprecated and will be removed in a future release.
def opt_class(self, className): (source)
Create a Resource subclass with a zero-argument constructor.
def opt_resource_script(self, name): (source)
An .rpy file to be used as the root resource of the webserver.
def opt_wsgi(self, name): (source)
The FQPN of a WSGI application object to serve as the root resource of the webserver.
def opt_mime_type(self, defaultType): (source)
Specify the default mime-type for static files.
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_flashconduit(self, port=None): (source)
Start a flashconduit on the specified port.
def postOptions(self): (source)
overrides twisted.python.usage.Options.postOptions

Set up conditional defaults and check for dependencies.

If SSL is not available but an HTTPS server was configured, raise a UsageError indicating that this is not possible.

If no server port was supplied, select a default appropriate for the other options supplied.
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.