SlyAPI.webapi

Implementation for following classes:

• WebAPI

Functions

is_dataclass_instance(obj)

Classes

WebAPI(auth[, use_form_data])

Base class for web APIs

SlyAPI.webapi.is_dataclass_instance(obj)

Parameters:

obj (object) –

Return type:

TypeIs[DataclassInstance]

class SlyAPI.webapi.WebAPI(auth, use_form_data=False)

Bases: object

Base class for web APIs

Parameters:

• auth (Auth) –

• use_form_data (bool) –

base_url: str

auth: Auth

get_full_url(path)

Convert a relative path to an absolute url for this API

Parameters:

path (str) –

Return type:

str

await delete_json(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (Any) –

• headers (dict[str, str] | None) –

await get_json(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (dict[str, int | float | bool | str | None | list['JsonType'] | dict[str, 'JsonType']] | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await post_json(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (dict[str, int | float | bool | str | None | list['JsonType'] | dict[str, 'JsonType']] | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await post_json_empty(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (dict[str, int | float | bool | str | None | list['JsonType'] | dict[str, 'JsonType']] | None) –

• headers (dict[str, str] | None) –

await put_json(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (dict[str, int | float | bool | str | None | list['JsonType'] | dict[str, 'JsonType']] | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await get_form(path, params=None, data=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• data (Any | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await post_form(path, params=None, data=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• data (Any | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await post_form_empty(path, params=None, data=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• data (Any | None) –

• headers (dict[str, str] | None) –

await put_form(path, params=None, data=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• data (Any | None) –

• headers (dict[str, str] | None) –

Return type:

dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]

await get_text(path, params=None, json=None, headers=None)

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]] | None) –

• json (dict[str, int | float | bool | str | None | list['JsonType'] | dict[str, 'JsonType']] | None) –

• headers (dict[str, str] | None) –

Return type:

str

paginated(path, params, limit)

Return an awaitable and async iterable over google or twitter-style paginated items. You can also await the return value to get the entire list.

Parameters:

• path (str) –

• params (Mapping[str, int | str | Enum | None | Set[ParamType] | Sequence[ParamType]]) –

• limit (int | None) –

Return type:

AsyncLazy[dict[str, int | float | bool | str | None | list[‘JsonType’] | dict[str, ‘JsonType’]]]