Go to the latest version of this document.

# ``twisted`.`web`.`xmlrpc`.`Proxy``

class documentation

`class Proxy: (source)`

Constructor: `Proxy(url, user, password, allowNone, ...)`

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.

Method | `__init__` | No summary
Method | `callRemote` | Call remote XML-RPC `method` with given arguments.
Instance Variable | `allowNone` | allow the use of None values in parameters. It's passed to the underlying `xmlrpclib` implementation. Defaults to `False`.
Instance Variable | `connectTimeout` | Number of seconds to wait before assuming the connection has failed.
Instance Variable | `host` | Undocumented
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.
Instance Variable | `path` | Undocumented
Instance Variable | `port` | Undocumented
Instance Variable | `queryFactory` | Object returning a factory for XML-RPC protocol. Use this for testing, or to manipulate the XML-RPC parsing behavior. For example, you may set this to a custom "debugging" factory object that reimplements ...
Instance Variable | `secure` | Undocumented
Instance Variable | `useDateTime` | Accept datetime values as datetime.datetime objects. also passed to the underlying `xmlrpclib` implementation. Defaults to `False`.
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.
Instance Variable | `_reactor` | The reactor used to create connections.

def __init__(self, url, user=None, password=None, allowNone=False, useDateTime=False, connectTimeout=30.0, reactor=None): (source)

Parameters
url:`bytes` | The 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.
user | Undocumented
password | Undocumented
allowNone | Undocumented
useDateTime | Undocumented
connectTimeout | Undocumented
reactor | Undocumented

def callRemote(self, method, *args): (source)

Call remote XML-RPC `method` with given arguments.

Returns
a `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`.

allowNone: `bool` or `None` = (source)

allow the use of None values in parameters. It's passed to the underlying `xmlrpclib` implementation. Defaults to `False`.

connectTimeout: `float` = (source)

Number of seconds to wait before assuming the connection has failed.

host = (source)

Undocumented

password: `bytes` or `None` = (source)

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.

path: `bytes` = (source)

Undocumented

port = (source)

Undocumented

queryFactory: `twisted.web.xmlrpc.QueryFactory` = (source)

Object returning a factory for XML-RPC protocol. Use this for testing, or to manipulate the XML-RPC parsing behavior. For example, you may set this to a custom "debugging" factory object that reimplements `parseResponse` in order to log the raw XML-RPC contents from the server before continuing on with parsing. Another possibility is to implement your own XML-RPC marshaller here to handle non-standard XML-RPC traffic.

secure = (source)

Undocumented

useDateTime: `bool` = (source)

Accept datetime values as datetime.datetime objects. also passed to the underlying `xmlrpclib` implementation. Defaults to `False`.

user: `bytes` or `None` = (source)

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.

_reactor: Object providing `twisted.internet.interfaces.IReactorTCP` = (source)

The reactor used to create connections.