Client

class clients.Client(url, trailing=”, headers=(), **attrs)

Bases: requests.sessions.Session

A Session which sends requests to a base url.

Parameters:

• url – base url for requests
• trailing – trailing chars (e.g. /) appended to the url
• headers – additional headers to include in requests
• attrs – additional Session attributes

__truediv__(path)

Return a cloned Client with appended path.

delete(path=”, **kwargs)

DELETE request with optional path.

get(path=”, **kwargs)

GET request with optional path.

head(path=”, **kwargs)

HEAD request with optional path.

options(path=”, **kwargs)

OPTIONS request with optional path.

patch(path=”, json=None, **kwargs)

PATCH request with optional path and json body.

post(path=”, json=None, **kwargs)

POST request with optional path and json body.

put(path=”, json=None, **kwargs)

PUT request with optional path and json body.

request(method, path, **kwargs)

Send request with relative or absolute path and return response.

Resource

class clients.Resource(url, trailing=”, headers=(), **attrs)

Bases: clients.syncs.Client

A Client which returns json content and has syntactic support for requests.

__call__(path=”, **params)

GET request with params.

__contains__(path)

Return whether endpoint exists according to HEAD request.

__delitem__(path=”, **kwargs)

DELETE request with optional path.

__getattr__(name)

Return a cloned Resource with appended path.

__getitem__(path=”, **kwargs)

GET request with optional path.

__iter__(path=”, **kwargs)

Iterate lines or chunks from streamed GET request.

__setitem__(path=”, json=None, **kwargs)

PUT request with optional path and json body.

client

Upcasted Client.

create(path=”, json=None, **kwargs)

POST request and return location.

download(file, path=”, **kwargs)

Output streamed GET request to file.

iter(path=”, **kwargs)

Iterate lines or chunks from streamed GET request.

request(method, path, **kwargs)

Send request with path and return processed content.

update(path=”, **json)

PATCH request with json params.

AsyncClient

class clients.AsyncClient(url, trailing=”, **attrs)

Bases: aiohttp.client.ClientSession

An asynchronous ClientSession which sends requests to a base url.

Parameters:

• url – base url for requests
• trailing – trailing chars (e.g. /) appended to the url
• attrs – additional ClientSession options, e.g., loop

__truediv__(path)

Return a cloned Client with appended path.

delete(path=”, **kwargs)

DELETE request with optional path.

get(path=”, **kwargs)

GET request with optional path.

head(path=”, **kwargs)

HEAD request with optional path.

options(path=”, **kwargs)

OPTIONS request with optional path.

patch(path=”, json=None, **kwargs)

PATCH request with optional path and json body.

post(path=”, json=None, **kwargs)

POST request with optional path and json body.

put(path=”, json=None, **kwargs)

PUT request with optional path and json body.

AsyncResource

class clients.AsyncResource(url, trailing=”, **attrs)

Bases: clients.asyncs.AsyncClient

An AsyncClient which returns json content and has syntactic support for requests.

__call__(path=”, **params)

GET request with params.

__getattr__(path)

Return a cloned Client with appended path.

__getitem__(path=”, **kwargs)

GET request with optional path.

client

Upcasted AsyncClient.

update(path=”, **json)

PATCH request with json params.

singleton

clients.singleton(*args, **kwargs)

Return a decorator for singleton class instances.