pyams_utils.protocol package ⊞

pyams_utils.protocol.http

PyAMS_utils.protocol.http module

This module provides an HTTP client class, which allows to easilly define proxies and authentication headers.

class pyams_utils.protocol.http.HTTPClient(method, protocol, servername, url, params=None, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers=None)

Bases: object

HTTP client with proxy support

Intialize HTTP connection

get_response()

Common HTTP request

pyams_utils.protocol.http.get_client(method, protocol, servername, url, params=None, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers=None)

HTTP client factory

pyams_utils.protocol.http.get_client_from_url(url, credentials=(), proxy=(), rdns=True, proxy_auth=(), timeout=None, headers=None)

HTTP client factory from URL

pyams_utils.protocol.tcp

PyAMS_utils.protocol.tcp module

This module only provides a single function, used to know if a given TCP port is already in use

pyams_utils.protocol.tcp.is_port_in_use(port, hostname='localhost')

Check if given port is already used locally

pyams_utils.protocol.xmlrpc

PyAMS_utils.protocol.xmlrpc module

This module provides a few set of classes and functions usable to improve XML-RPC client usage.

It provides custom transports and allows storage of response cookies

class pyams_utils.protocol.xmlrpc.SecureXMLRPCCookieAuthTransport(user_agent, credentials=(), cookies=None, timeout=<object object>, headers=None)

Bases: pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport

Secure XML-RPC transport

class pyams_utils.protocol.xmlrpc.XMLRPCCookieAuthTransport(user_agent, credentials=(), cookies=None, timeout=<object object>, headers=None)

Bases: xmlrpc.client.Transport

An XML-RPC transport handling authentication via cookies

class CookieRequest(url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None)

Bases: urllib.request.Request

Dummy request class used for extracting cookies

class CookieResponse(response)

Bases: object

Dummy response class used to extract cookies

info()

Get response info from cookies

class CookieResponseHelper(response)

Bases: object

Dummy response headers helper

getheaders(header)

Get response headers

get_response(connection, host, handler)

Get server response

make_connection(host)

request(host, handler, request_body, verbose=False)

send_auth(connection)

Override the send_host hook to also send authentication info

static send_content_type(connection)

Send content type

send_headers(connection, headers)

Send custom headers

send_request(host, handler, request_body, debug)

send_user_agent(connection)

Send user agent

verbose = False

pyams_utils.protocol.xmlrpc.get_client(uri, credentials=(), verbose=False, allow_none=0, timeout=<object object>, headers=None)

Get an XML-RPC client which supports basic authentication

pyams_utils.protocol.xmlrpc.get_client_with_cookies(uri, credentials=(), verbose=False, allow_none=0, timeout=<object object>, headers=None, cookies=None)

Get an XML-RPC client which supports authentication through cookies