foundry_dev_tools.clients.context_client module

foundry_dev_tools.clients.context_client module#

HTTP client implementations, for the context and the base for API clients.

foundry_dev_tools.clients.context_client.retry(times, exceptions)[source]#

Retry Decorator.

Code Copied from https://stackoverflow.com/a/64030200

Retries the wrapped function/method times times if the exceptions listed in exceptions are thrown :param times: The number of times to repeat the wrapped function/method :type times: Int :param Exceptions: Lists of exceptions that trigger a retry attempt :type Exceptions: Tuple of Exceptions

Parameters:
Return type:

Callable

class foundry_dev_tools.clients.context_client.ContextHTTPClient[source]#

Bases: Session

Requests Session with config and authentication applied.

__init__(context)[source]#
Parameters:

context (FoundryContext)

Return type:

None

request(**kwargs)[source]#

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 long 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

Contents