twisted.web.xmlrpc.XMLRPC

class documentation

class XMLRPC(resource.Resource): (source)

Known subclasses: twisted.web.xmlrpc.XMLRPCIntrospection

Constructor: XMLRPC(allowNone, useDateTime)

A resource that implements XML-RPC.

You probably want to connect this to '/RPC2'.

Methods published can return XML-RPC serializable results, Faults, Binary, Boolean, DateTime, Deferreds, or Handler instances.

By default methods beginning with 'xmlrpc_' are published.

Sub-handlers for prefixed methods (e.g., system.listMethods) can be added with putSubHandler. By default, prefixes are separated with a '.'. Override self.separator to change this.

Method	`__init__`	Initialize.
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:

Method	`delEntity`	Undocumented
Method	`getChild`	Retrieve a 'child' resource from me.
Method	`getChildForRequest`	Deprecated in favor of `getChildForRequest`.
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, allowNone=False, useDateTime=False): (source) ¶

overrides twisted.web.resource.Resource.__init__

overridden in twisted.web.xmlrpc.XMLRPCIntrospection

Initialize.

def __setattr__(self, name, value): (source) ¶

Undocumented

def getSubHandler(self, prefix): (source) ¶

Undocumented

def getSubHandlerPrefixes(self): (source) ¶

Undocumented

def listProcedures(self): (source) ¶

Return a list of the names of all xmlrpc procedures.

Present Since
11.1

def lookupProcedure(self, procedurePath): (source) ¶

Given a string naming a procedure, return a callable object for that procedure or raise NoSuchFunction.

The returned object will be called, and should return the result of the procedure, a Deferred, or a Fault instance.

Override in subclasses if you want your own policy. The base implementation that given 'foo', self.xmlrpc_foo will be returned. If procedurePath contains self.separator, the sub-handler for the initial prefix is used to search for the remaining path.

If you override lookupProcedure, you may also want to override listProcedures to accurately report the procedures supported by your resource, so that clients using the system.listMethods procedure receive accurate results.