t.w.x.XMLRPC(resource.Resource) : class documentation

Part of twisted.web.xmlrpc View Source View In Hierarchy

Known subclasses: twisted.web.xmlrpc.XMLRPCIntrospection

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.

Instance Variable allowNone Permit XML translating of Python constant None. (type: bool)
Instance Variable useDateTime Present datetime values as datetime.datetime objects? Requires Python >= 2.5. (type: bool)
Method __init__ Initialize.
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:

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.
allowNone =
Permit XML translating of Python constant None. (type: bool)
useDateTime =
Present datetime values as datetime.datetime objects? Requires Python >= 2.5. (type: bool)
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 putSubHandler(self, prefix, handler): (source)
Undocumented
def getSubHandler(self, prefix): (source)
Undocumented
def getSubHandlerPrefixes(self): (source)
Undocumented
def render_POST(self, request): (source)
Undocumented
def _cbRender(self, result, request, responseFailed=None): (source)
Undocumented
def _ebRender(self, failure): (source)
Undocumented
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.

Present Since11.1
def listProcedures(self): (source)
Return a list of the names of all xmlrpc procedures.
Present Since11.1
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.