twisted.web.xmlrpc.XMLRPCIntrospection(XMLRPC) class documentation

Part of twisted.web.xmlrpc (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:

Instance Variable allowNone Permit XML translating of Python constant None. (type: bool)
Instance Variable useDateTime Present datetime values as datetime.datetime objects? (type: bool)
Method __setattr__ Undocumented
Method putSubHandler Undocumented
Method getSubHandler Undocumented
Method getSubHandlerPrefixes Undocumented
Method render_POST Undocumented
Method lookupProcedure Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction.
Method listProcedures Return a list of the names of all xmlrpc procedures.
Method _cbRender Undocumented
Method _ebRender Undocumented

Inherited from Resource (via XMLRPC):

Method listStaticNames Undocumented
Method listStaticEntities Undocumented
Method listNames Undocumented
Method listEntities Undocumented
Method listDynamicNames Undocumented
Method listDynamicEntities Undocumented
Method getStaticEntity Undocumented
Method getDynamicEntity Undocumented
Method delEntity Undocumented
Method reallyPutEntity Undocumented
Method getChild Retrieve a 'child' resource from me.
Method getChildWithDefault Retrieve a static or dynamically generated child resource from me.
Method getChildForRequest Undocumented
Method putChild Register a static child.
Method render Render a given resource. See IResource's render method.
Method render_HEAD Default handling of HEAD method.
def __init__(self, parent):
overrides twisted.web.xmlrpc.XMLRPC.__init__

Implement Introspection support for an XMLRPC server.

Parametersparentthe XMLRPC server to add Introspection support to. (type: XMLRPC)
def xmlrpc_listMethods(self):

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

def xmlrpc_methodHelp(self, method):

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

def xmlrpc_methodSignature(self, method):

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 2020-03-25 17:34:30.