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_list​Methods Return a list of the method names implemented by this server.
Method xmlrpc_method​Help Return a documentation string describing the use of the given method.
Method xmlrpc_method​Signature Return a list of type signatures.
Instance Variable _xmlrpc​_parent Undocumented

Inherited from XMLRPC:

Method __setattr__ Undocumented
Method get​Sub​Handler Undocumented
Method get​Sub​Handler​Prefixes Undocumented
Method list​Procedures Return a list of the names of all xmlrpc procedures.
Method lookup​Procedure Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction.
Method put​Sub​Handler Undocumented
Method render_​POST Undocumented
Constant FAILURE Undocumented
Constant NOT​_FOUND Undocumented
Class Variable allowed​Methods Undocumented
Class Variable is​Leaf 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 allow​None Permit XML translating of Python constant None.
Instance Variable sub​Handlers Undocumented
Instance Variable use​Date​Time Present datetime values as datetime.datetime objects?
Method _cb​Render Undocumented
Method _eb​Render Undocumented
Class Variable _log Undocumented

Inherited from Resource (via XMLRPC):

Method del​Entity Undocumented
Method get​Child Retrieve a 'child' resource from me.
Method get​Child​For​Request Undocumented
Method get​Child​With​Default Retrieve a static or dynamically generated child resource from me.
Method get​Dynamic​Entity Undocumented
Method get​Static​Entity Undocumented
Method list​Dynamic​Entities Undocumented
Method list​Dynamic​Names Undocumented
Method list​Entities Undocumented
Method list​Names Undocumented
Method list​Static​Entities Undocumented
Method list​Static​Names Undocumented
Method put​Child Register a static child.
Method really​Put​Entity 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:XMLRPCthe 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