twisted.web.xmlrpc.Proxy class documentation

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

A Proxy for making remote XML-RPC calls.

Pass the URL of the remote XML-RPC server to the constructor.

Use proxy.callRemote('foobar', *args) to call remote method 'foobar' with *args.

Instance Variable user The username with which to authenticate with the server when making calls. If specified, overrides any username information embedded in url. If not specified, a value may be taken from url if present. (type: bytes or NoneType)
Instance Variable password The password with which to authenticate with the server when making calls. If specified, overrides any password information embedded in url. If not specified, a value may be taken from url if present. (type: bytes or NoneType)
Instance Variable allowNone allow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool or NoneType)
Instance Variable useDateTime Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool)
Instance Variable connectTimeout Number of seconds to wait before assuming the connection has failed. (type: float)
Instance Variable queryFactory Object returning a factory for XML-RPC protocol. Mainly useful for tests.
Method __init__ No summary
Method callRemote Call remote XML-RPC method with given arguments.
Instance Variable _reactor The reactor used to create connections. (type: Object providing twisted.internet.interfaces.IReactorTCP)
user =
The username with which to authenticate with the server when making calls. If specified, overrides any username information embedded in url. If not specified, a value may be taken from url if present. (type: bytes or NoneType)
password =
The password with which to authenticate with the server when making calls. If specified, overrides any password information embedded in url. If not specified, a value may be taken from url if present. (type: bytes or NoneType)
allowNone =
allow the use of None values in parameters. It's passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool or NoneType)
useDateTime =
Accept datetime values as datetime.datetime objects. also passed to the underlying xmlrpclib implementation. Defaults to False. (type: bool)
connectTimeout =
Number of seconds to wait before assuming the connection has failed. (type: float)
_reactor =
The reactor used to create connections. (type: Object providing twisted.internet.interfaces.IReactorTCP)
queryFactory =
Object returning a factory for XML-RPC protocol. Mainly useful for tests.
def __init__(self, url, user=None, password=None, allowNone=False, useDateTime=False, connectTimeout=30.0, reactor=reactor): (source)
ParametersurlThe URL to which to post method calls. Calls will be made over SSL if the scheme is HTTPS. If netloc contains username or password information, these will be used to authenticate, as long as the user and password arguments are not specified. (type: bytes)
def callRemote(self, method, *args): (source)

Call remote XML-RPC method with given arguments.

Returnsa defer.Deferred that will fire with the method response, or a failure if the method failed. Generally, the failure type will be Fault, but you can also have an IndexError on some buggy servers giving empty responses.

If the deferred is cancelled before the request completes, the connection is closed and the deferred will fire with a defer.CancelledError.

API Documentation for Twisted, generated by pydoctor at 2016-04-04 15:02:49.