twisted.web.xmlrpc.Proxy : API documentation

class documentation

class twisted.web.xmlrpc.Proxy: (source)

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.
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	allowNone	allow the use of None values in parameters. It's passed to the underlying `xmlrpclib` implementation. Defaults to `False`.
Instance Variable	useDateTime	Accept datetime values as datetime.datetime objects. also 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	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 `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.
Method	__init__	No summary
Instance Variable	host	Undocumented
Instance Variable	port	Undocumented
Instance Variable	path	Undocumented
Instance Variable	secure	Undocumented
Method	callRemote	Call remote XML-RPC `method` with given arguments.
Instance Variable	_reactor	The reactor used to create connections.

user = (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.

(type: bytes or None)

password = (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.

(type: bytes or None)

allowNone = (source)

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

(type: bool or None)

useDateTime = (source)

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

(type: bool)

connectTimeout = (source)

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

(type: float)

_reactor = (source)

The reactor used to create connections.

(type: Object providing twisted.internet.interfaces.IReactorTCP)

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.

(type: twisted.web.xmlrpc.QueryFactory)

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

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

host = (source)

Undocumented

port = (source)

Undocumented

path = (source)

Undocumented

(type: bytes)

secure = (source)

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.

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