Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`web`.`vhost`.`NameVirtualHost``

class documentation

`class NameVirtualHost(resource.Resource): (source)`

Constructor: `NameVirtualHost()`

View In Hierarchy

I am a resource which represents named virtual hosts.

Method | `__init__` | Initialize.
Method | `addHost` | Add a host to this virtual host.
Method | `getChild` | Implementation of resource.Resource's getChild method.
Method | `getStaticEntity` | Undocumented
Method | `listStaticEntities` | Undocumented
Method | `removeHost` | Remove a host.
Method | `render` | Implementation of resource.Resource's render method.
Class Variable | `default` | Undocumented
Instance Variable | `hosts` | Undocumented
Method | `_getResourceForRequest` | (Internal) Get the appropriate resource for the given host.

Inherited from `Resource`:

Method | `delEntity` | Undocumented
Method | `getChildForRequest` | Deprecated in favor of `getChildForRequest`.
Method | `getChildWithDefault` | Retrieve a static or dynamically generated child resource from me.
Method | `getDynamicEntity` | Undocumented
Method | `listDynamicEntities` | Undocumented
Method | `listDynamicNames` | Undocumented
Method | `listEntities` | Undocumented
Method | `listNames` | Undocumented
Method | `listStaticNames` | Undocumented
Method | `putChild` | Register a static child.
Method | `reallyPutEntity` | Undocumented
Method | `render_HEAD` | Default handling of HEAD method.
Class Variable | `allowedMethods` | Undocumented
Class Variable | `isLeaf` | Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Class Variable | `server` | Undocumented
Instance Variable | `children` | Undocumented

def __init__(self): (source)
overrides `twisted.web.resource.Resource.__init__`

Initialize.

def addHost(self, name, resrc): (source)

Add a host to this virtual host.

This will take a host named `name', and map it to a resource `resrc'. For example, a setup for our virtual hosts would be:

        nvh.addHost('divunal.com', divunalDirectory)
        nvh.addHost('www.divunal.com', divunalDirectory)
        nvh.addHost('twistedmatrix.com', twistedMatrixDirectory)
        nvh.addHost('www.twistedmatrix.com', twistedMatrixDirectory)

def getChild(self, path, request): (source)
overrides `twisted.web.resource.Resource.getChild`

Implementation of resource.Resource's getChild method.

def getStaticEntity(self, name): (source)
overrides `twisted.web.resource.Resource.getStaticEntity`

Undocumented

def listStaticEntities(self): (source)
overrides `twisted.web.resource.Resource.listStaticEntities`

Undocumented

def removeHost(self, name): (source)

Remove a host.

def render(self, request): (source)
from `twisted.web.resource.IResource`
overrides `twisted.web.resource.Resource.render`

Implementation of resource.Resource's render method.

default = (source)

Undocumented

hosts: `dict` = (source)

Undocumented

def _getResourceForRequest(self, request): (source)

(Internal) Get the appropriate resource for the given host.