l.c.b.Connection(object) : class documentation

Part of libcloud.common.base View Source View In Hierarchy

Known subclasses: libcloud.common.base.PollingConnection, libcloud.compute.base.ConnectionKey

A Base Connection class to derive from.
Method __init__ Undocumented
Method set_context Undocumented
Method connect Establish a connection with the API server.
Method user_agent_append Append a token to a user agent string.
Method request Request a given `action`.
Method morph_action_hook Undocumented
Method add_default_params Adds default parameters (such as API key, version, etc.) to the passed `params`
Method add_default_headers Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`
Method pre_connect_hook A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.
Method encode_data Encode body data.
Method _tuple_from_url Undocumented
Method _user_agent Undocumented
def __init__(self, secure=True, host=None, port=None, url=None, timeout=None): (source)
Undocumented
def set_context(self, context): (source)
Undocumented
def _tuple_from_url(self, url): (source)
Undocumented
def connect(self, host=None, port=None, base_url=None): (source)
Establish a connection with the API server.
ParametershostOptional host to override our default (type: str)
portOptional port to override our default (type: int)
ReturnsA connection
def _user_agent(self): (source)
Undocumented
def user_agent_append(self, token): (source)
Append a token to a user agent string.

Users of the library should call this to uniquely identify thier requests to a provider.

ParameterstokenToken to add to the user agent. (type: str)
def request(self, action, params=None, data='', headers=None, method='GET', raw=False): (source)
Request a given `action`.

Basically a wrapper around the connection object's `request` that does some helpful pre-processing.

ParametersactionA path (type: str)
paramsOptional mapping of additional parameters to send. If None, leave as an empty dict. (type: dict)
dataA body of data to send with the request. (type: unicode)
headersExtra headers to add to the request None, leave as an empty dict. (type: dict)
methodAn HTTP method such as "GET" or "POST". (type: str)
rawTrue to perform a "raw" request aka only send the headers and use the rawResponseCls class. This is used with storage API when uploading a file. (type: bool)
ReturnsAn instance of type responseCls
def morph_action_hook(self, action): (source)
Undocumented
def add_default_params(self, params): (source)
Adds default parameters (such as API key, version, etc.) to the passed `params`

Should return a dictionary.

def add_default_headers(self, headers): (source)
Adds default headers (such as Authorization, X-Foo-Bar) to the passed `headers`

Should return a dictionary.

def pre_connect_hook(self, params, headers): (source)
A hook which is called before connecting to the remote server. This hook can perform a final manipulation on the params, headers and url parameters.
ParametersparamsRequest parameters. (type: dict)
headersRequest headers. (type: dict)
def encode_data(self, data): (source)
Encode body data.

Override in a provider's subclass.

API Documentation for libcloud, generated by pydoctor at 2012-07-28 18:57:18.