gafferpy.client package

Submodules

gafferpy.client.base_client module

class gafferpy.client.base_client.BaseClient(base_url, verbose=False, headers={}, **kwargs)

Bases: object

This class handles the connection to a Gaffer server and handles operations. This class is initialised with a host to connect to.

merge_headers(headers)
perform_request(method, target, headers=None, body=None, json_result=True)

gafferpy.client.pki_client module

class gafferpy.client.pki_client.PkiClient(base_url, verbose=False, headers={}, **kwargs)

Bases: UrllibClient

gafferpy.client.requests_client module

class gafferpy.client.requests_client.RequestsClient(base_url, verbose=False, headers={}, **kwargs)

Bases: BaseClient

This class handles the connection to a Gaffer server and handles operations. This class is initialised with a host to connect to.

perform_request(method, target, headers=None, body=None, json_result=True)
class gafferpy.client.requests_client.SSLAdapter(ssl_version=None, **kwargs)

Bases: HTTPAdapter

A subclass of the HTTPS Transport Adapter that is used to setup an arbitrary SSL version for the requests session.

init_poolmanager(connections, maxsize, block=False)

Initializes a urllib3 PoolManager.

This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parameters:

  • connections – The number of urllib3 connection pools to cache.

  • maxsize – The maximum number of connections to save in the pool.

  • block – Block when no free connections are available.

  • pool_kwargs – Extra keyword arguments used to initialize the Pool Manager.

gafferpy.client.urllib_client module

class gafferpy.client.urllib_client.UrllibClient(base_url, verbose=False, headers={}, **kwargs)

Bases: BaseClient

This class handles the connection to a Gaffer server and handles operations. This class is initialised with a host to connect to.

perform_request(method, target, headers=None, body=None, json_result=True)

Module contents