Core3Session

Documentation for eth_defi.core3.session.Core3Session Python class.

class Core3Session

Bases: requests.sessions.Session

A requests.Session subclass for Core3 API.

Carries the API URL and API key, and sets required default headers (User-Agent and x-api-key). All Core3 fetch functions accept a Core3Session and read api_url from it.

Use create_core3_session() to create instances.

Attributes summary

Methods summary

`__init__`([api_url, api_key])
`close`()	Closes all adapters and as such the session
`delete`(url, **kwargs)	Sends a DELETE request.
`get`(url, **kwargs)	Sends a GET request.
`get_adapter`(url)	Returns the appropriate connection adapter for the given URL.
`get_redirect_target`(resp)	Receives a Response.
`head`(url, **kwargs)	Sends a HEAD request.
`merge_environment_settings`(url, proxies, ...)	Check the environment and merge it with some settings.
`mount`(prefix, adapter)	Registers a connection adapter to a prefix.
`options`(url, **kwargs)	Sends a OPTIONS request.
`patch`(url[, data])	Sends a PATCH request.
`post`(url[, data, json])	Sends a POST request.
`prepare_request`(request)	Constructs a `PreparedRequest` for transmission and returns it.
`put`(url[, data])	Sends a PUT request.
`rebuild_auth`(prepared_request, response)	When being redirected we may want to strip authentication from the request to avoid leaking credentials.
`rebuild_method`(prepared_request, response)	When being redirected we may want to change the method of the request based on certain specs or browser behavior.
`rebuild_proxies`(prepared_request, proxies)	This method re-evaluates the proxy configuration by considering the environment variables.
`request`(method, url[, params, data, ...])	Constructs a `Request`, prepares it and sends it.
`resolve_redirects`(resp, req[, stream, ...])	Receives a Response.
`send`(request, **kwargs)	Send a given PreparedRequest.
`should_strip_auth`(old_url, new_url)	Decide whether Authorization header should be removed when redirecting

__init__(api_url='https://api.core3.io/projects_data', api_key=None)

Parameters

api_url (str) –
api_key (Optional[str]) –

close(): Closes all adapters and as such the session

delete(url, **kwargs)

Sends a DELETE request. Returns Response object.

Parameters

url – URL for the new Request object.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

get(url, **kwargs)

Sends a GET request. Returns Response object.

Parameters

url – URL for the new Request object.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

get_adapter(url)

Returns the appropriate connection adapter for the given URL.

Return type: requests.adapters.BaseAdapter

get_redirect_target(resp): Receives a Response. Returns a redirect URI or None

head(url, **kwargs)

Sends a HEAD request. Returns Response object.

Parameters

url – URL for the new Request object.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

merge_environment_settings(url, proxies, stream, verify, cert)

Check the environment and merge it with some settings.

Return type: dict

mount(prefix, adapter)

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by prefix length.

options(url, **kwargs)

Sends a OPTIONS request. Returns Response object.

Parameters

url – URL for the new Request object.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

patch(url, data=None, **kwargs)

Sends a PATCH request. Returns Response object.

Parameters

url – URL for the new Request object.
data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

post(url, data=None, json=None, **kwargs)

Sends a POST request. Returns Response object.

Parameters

url – URL for the new Request object.
data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.
json – (optional) json to send in the body of the Request.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

prepare_request(request)

Constructs a PreparedRequest for transmission and returns it. The PreparedRequest has settings merged from the Request instance and those of the Session.

Parameters: request – Request instance to prepare with this session’s settings.
Return type: requests.PreparedRequest

put(url, data=None, **kwargs)

Sends a PUT request. Returns Response object.

Parameters

url – URL for the new Request object.
data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.
**kwargs – Optional arguments that request takes.

Return type

requests.Response

rebuild_auth(prepared_request, response): When being redirected we may want to strip authentication from the request to avoid leaking credentials. This method intelligently removes and reapplies authentication where possible to avoid credential loss.

rebuild_method(prepared_request, response): When being redirected we may want to change the method of the request based on certain specs or browser behavior.

rebuild_proxies(prepared_request, proxies)

This method re-evaluates the proxy configuration by considering the environment variables. If we are redirected to a URL covered by NO_PROXY, we strip the proxy configuration. Otherwise, we set missing proxy keys for this URL (in case they were stripped by a previous redirect).

This method also replaces the Proxy-Authorization header where necessary.

Return type: dict

request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None, json=None)

Constructs a Request, prepares it and sends it. Returns Response object.

Parameters

method – method for the new Request object.
url – URL for the new Request object.
params – (optional) Dictionary or bytes to be sent in the query string for the Request.
data – (optional) Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.
json – (optional) json to send in the body of the Request.
headers – (optional) Dictionary of HTTP Headers to send with the Request.
cookies – (optional) Dict or CookieJar object to send with the Request.
files – (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload.
auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout (float or tuple) – (optional) How many seconds to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.
allow_redirects (bool) – (optional) Set to True by default.
proxies – (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
hooks – (optional) Dictionary mapping hook name to one event or list of events, event must be callable.
stream – (optional) whether to immediately download the response content. Defaults to False.
verify – (optional) Either a boolean, in which case it controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to True. When set to False, requests will accept any TLS certificate presented by the server, and will ignore hostname mismatches and/or expired certificates, which will make your application vulnerable to man-in-the-middle (MitM) attacks. Setting verify to False may be useful during local development or testing.
cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

Return type

requests.Response

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None, yield_requests=False, **adapter_kwargs): Receives a Response. Returns a generator of Responses or Requests.

send(request, **kwargs)

Send a given PreparedRequest.

Return type: requests.Response

should_strip_auth(old_url, new_url): Decide whether Authorization header should be removed when redirecting