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`.`soap`.`SOAPPublisher``

class documentation

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

View In Hierarchy

Publish SOAP methods.

By default, publish methods beginning with 'soap_'. If the method has an attribute 'useKeywords', it well get the arguments passed as keyword args.

Method | `lookupFunction` | Lookup published SOAP function.
Method | `render` | Handle a SOAP command.
Class Variable | `encoding` | 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.
Method | `_gotError` | Undocumented
Method | `_gotResult` | Undocumented
Method | `_methodNotFound` | Undocumented
Method | `_sendResponse` | Undocumented

Inherited from `Resource`:

Method | `__init__` | Initialize.
Method | `delEntity` | Undocumented
Method | `getChild` | Retrieve a 'child' resource from me.
Method | `getChildForRequest` | Undocumented
Method | `getChildWithDefault` | Retrieve a static or dynamically generated child resource from me.
Method | `getDynamicEntity` | Undocumented
Method | `getStaticEntity` | Undocumented
Method | `listDynamicEntities` | Undocumented
Method | `listDynamicNames` | Undocumented
Method | `listEntities` | Undocumented
Method | `listNames` | Undocumented
Method | `listStaticEntities` | Undocumented
Method | `listStaticNames` | Undocumented
Method | `putChild` | Register a static child.
Method | `reallyPutEntity` | Undocumented
Method | `render_HEAD` | Default handling of HEAD method.
Class Variable | `server` | Undocumented
Instance Variable | `children` | Undocumented

def lookupFunction(self, functionName): (source)

Lookup published SOAP function.

Override in subclasses. Default behaviour - publish methods starting with soap_.

Returns
callable or None if not found.

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

Handle a SOAP command.

encoding: `str` = (source)

Undocumented

isLeaf: `int` = (source)
from `twisted.web.resource.IResource`
overrides `twisted.web.resource.Resource.isLeaf`

Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.

def _gotError(self, failure, request, methodName): (source)

Undocumented

def _gotResult(self, result, request, methodName): (source)

Undocumented

def _methodNotFound(self, request, methodName): (source)

Undocumented

def _sendResponse(self, request, response, status=200): (source)

Undocumented