t.w.x.XMLRPCIntrospection(XMLRPC) : class documentation

Part of twisted.web2.xmlrpc View 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.

Inherited from XMLRPC:

Method putSubHandler Undocumented
Method getSubHandler Undocumented
Method getSubHandlerPrefixes Undocumented
Method render No summary
Method http_POST Undocumented
Method getFunction Given a string, return a function, or raise NoSuchFunction.
Method _cbDispatch Undocumented
Method _cbRender Undocumented
Method _ebRender Undocumented
Method _listFunctions Return a list of the names of all xmlrpc methods.

Inherited from Resource (via XMLRPC):

Method locateChild No summary
Method child_ This method locates a child with a trailing "/" in the URL. @param request: the request to process.
Method putChild Register a static child.
Method http_GET Respond to a GET request.

Inherited from RenderMixin (via XMLRPC, Resource):

Method allowedMethods
Method checkPreconditions No summary
Method renderHTTP See iweb.IResource.renderHTTP.
Method http_OPTIONS Respond to a OPTIONS request. @param request: the request to process. @return: an object adaptable to iweb.IResponse.
Method http_TRACE Respond to a TRACE request. @param request: the request to process. @return: an object adaptable to iweb.IResponse.
Method http_HEAD Respond to a HEAD request. @param request: the request to process. @return: an object adaptable to iweb.IResponse.
def __init__(self, parent): (source)
overrides twisted.web2.xmlrpc.XMLRPC.__init__
Implement Introspection support for an XMLRPC server.
Parametersparentthe XMLRPC server to add Introspection support to.
def xmlrpc_listMethods(self, request): (source)
Return a list of the method names implemented by this server.
def xmlrpc_methodHelp(self, request, method): (source)
Return a documentation string describing the use of the given method.
def xmlrpc_methodSignature(self, request, 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.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.