polyswarm_api.core

Module Contents

polyswarm_api.core.JSONDecodeError[source]
polyswarm_api.core.logger[source]
class polyswarm_api.core.PolyswarmSession(key, retries, user_agent=settings.DEFAULT_USER_AGENT, verify=True, **kwargs)[source]

Bases: requests.Session

requests_retry_session(self, retries=settings.DEFAULT_RETRIES, backoff_factor=settings.DEFAULT_BACKOFF, status_forcelist=settings.DEFAULT_RETRY_CODES)[source]
set_auth(self, key)[source]
set_user_agent(self, ua)[source]
class polyswarm_api.core.RequestParamsEncoder[source]

Bases: json.JSONEncoder

default(self, obj)[source]
class polyswarm_api.core.PolyswarmRequest(api_instance, request_parameters, key=None, result_parser=None, **kwargs)[source]

Bases: object

This class holds a requests-compatible dictionary and extra information we need to parse the response.

result(self)[source]
execute(self)[source]
_bad_status_message(self)[source]
_extract_json_body(self, result)[source]
parse_result(self, result)[source]
__iter__(self)[source]
consume_results(self)[source]
next_page(self)[source]
class polyswarm_api.core.BaseResource(content, *args, **kwargs)[source]

Bases: object

classmethod parse_result(cls, api, content, **kwargs)[source]
class polyswarm_api.core.BaseJsonResource(content, *args, **kwargs)[source]

Bases: polyswarm_api.core.BaseResource

RESOURCE_ENDPOINT[source]
RESOURCE_ID_KEYS = ['id'][source]
__int__(self)[source]
_get(self, path, default=None, content=None)[source]

Helper for rendering attributes of child objects in the json that might be None. Returns the default value if any item in the path is not present.

classmethod parse_result_list(cls, api_instance, json_data, **kwargs)[source]
classmethod _endpoint(cls, api, **kwargs)[source]
classmethod _list_endpoint(cls, api, **kwargs)[source]
classmethod _create_endpoint(cls, api, **kwargs)[source]
classmethod _get_endpoint(cls, api, **kwargs)[source]
classmethod _head_endpoint(cls, api, **kwargs)[source]
classmethod _update_endpoint(cls, api, **kwargs)[source]
classmethod _delete_endpoint(cls, api, **kwargs)[source]
classmethod _params(cls, method, *param_keys, **kwargs)[source]
classmethod _list_params(cls, **kwargs)[source]
classmethod _create_params(cls, **kwargs)[source]
classmethod _get_params(cls, **kwargs)[source]
classmethod _head_params(cls, **kwargs)[source]
classmethod _update_params(cls, **kwargs)[source]
classmethod _delete_params(cls, **kwargs)[source]
classmethod _list_headers(cls, api)[source]
classmethod _create_headers(cls, api)[source]
classmethod _get_headers(cls, api)[source]
classmethod _head_headers(cls, api)[source]
classmethod _update_headers(cls, api)[source]
classmethod _delete_headers(cls, api)[source]
classmethod _build_request(cls, api, method, url, headers, params, json_params)[source]
classmethod create(cls, api, **kwargs)[source]
classmethod get(cls, api, **kwargs)[source]
classmethod head(cls, api, **kwargs)[source]
classmethod update(cls, api, **kwargs)[source]
classmethod delete(cls, api, **kwargs)[source]
classmethod list(cls, api, **kwargs)[source]
polyswarm_api.core.is_hex(value)[source]
polyswarm_api.core.is_valid_sha1(value)[source]
polyswarm_api.core.is_valid_md5(value)[source]
polyswarm_api.core.is_valid_sha256(value)[source]
class polyswarm_api.core.Hashable(*args, **kwargs)[source]

Bases: object

SUPPORTED_HASH_TYPES[source]
hash[source]
hash_type[source]
raw[source]
validate(self)[source]
resolve_hash_type(self)[source]
__eq__(self, other)[source]
polyswarm_api.core.parse_isoformat(date_string)[source]
Parses the current date format version