twisted.web.xmlrpc.XMLRPCIntrospection : API documentation

class documentation

class twisted.web.xmlrpc.XMLRPCIntrospection(XMLRPC): (source)

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:

Instance Variable	allowNone	Permit XML translating of Python constant None.
Instance Variable	useDateTime	Present `datetime` values as `datetime.datetime` objects?
Class Variable	NOT_FOUND	Undocumented
Class Variable	FAILURE	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
Class Variable	allowedMethods	Undocumented
Instance Variable	subHandlers	Undocumented
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.
Class Variable	_log	Undocumented
Method	_cbRender	Undocumented
Method	_ebRender	Undocumented

Inherited from Resource (via XMLRPC):

Class Variable	server	Undocumented
Instance Variable	children	Undocumented
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): (source)

overrides twisted.web.xmlrpc.XMLRPC.__init__

Implement Introspection support for an XMLRPC server.

Parameters parent the XMLRPC server to add Introspection support to. (type: XMLRPC)

_xmlrpc_parent = (source)

Undocumented

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.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.