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`.`xmlrpc`.`XMLRPCIntrospection``

class documentation

`class XMLRPCIntrospection(XMLRPC): (source)`

View In Hierarchy

Implement the XML-RPC Introspection API.

By default, the methodHelp method returns the 'help' method attribute, if it exists, otherwise the __doc__ method attribute, if it exists, otherwise the empty string.

To enable the methodSignature method, add a 'signature' method attribute containing a list of lists. See methodSignature's documentation for the format. Note the type strings should be XML-RPC types, not Python types.

Method | `__init__` | Implement Introspection support for an XMLRPC server.
Method | `xmlrpc_listMethods` | Return a list of the method names implemented by this server.
Method | `xmlrpc_methodHelp` | Return a documentation string describing the use of the given method.
Method | `xmlrpc_methodSignature` | Return a list of type signatures.
Instance Variable | `_xmlrpc_parent` | Undocumented

Inherited from `XMLRPC`:

Method | `__setattr__` | Undocumented
Method | `getSubHandler` | Undocumented
Method | `getSubHandlerPrefixes` | Undocumented
Method | `listProcedures` | Return a list of the names of all xmlrpc procedures.
Method | `lookupProcedure` | Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction.
Method | `putSubHandler` | Undocumented
Method | `render_POST` | Undocumented
Constant | `FAILURE` | Undocumented
Constant | `NOT_FOUND` | Undocumented
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 | `separator` | Undocumented
Instance Variable | `allowNone` | Permit XML translating of Python constant None.
Instance Variable | `subHandlers` | Undocumented
Instance Variable | `useDateTime` | Present `datetime` values as `datetime.datetime` objects?
Method | `_cbRender` | Undocumented
Method | `_ebRender` | Undocumented
Class Variable | `_log` | Undocumented

Inherited from `Resource` (via `XMLRPC`):

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` | Render a given resource. See `IResource`'s render method.
Method | `render_HEAD` | Default handling of HEAD method.
Class Variable | `server` | Undocumented
Instance Variable | `children` | Undocumented

def __init__(self, parent): (source)
overrides `twisted.web.xmlrpc.XMLRPC.__init__`

Implement Introspection support for an XMLRPC server.

Parameters
parent:`XMLRPC` | the XMLRPC server to add Introspection support to.

def xmlrpc_listMethods(self): (source)

Return a list of the method names implemented by this server.

def xmlrpc_methodHelp(self, method): (source)

Return a documentation string describing the use of the given method.

def xmlrpc_methodSignature(self, method): (source)

Return a list of type signatures.

Each type signature is a list of the form [rtype, type1, type2, ...] where rtype is the return type and typeN is the type of the Nth argument. If no signature information is available, the empty string is returned.

_xmlrpc_parent = (source)

Undocumented