ahriman.core.http package
Submodules
ahriman.core.http.sync_ahriman_client module
- class SyncAhrimanClient(configuration: Configuration | None = None, section: str | None = None, *, suppress_errors: bool = False)
Bases:
SyncHttpClient
wrapper for ahriman web service
- address
address of the web service
- Type:
str
default constructor
- Parameters:
configuration (Configuration | None, optional) – configuration instance (Default value = None)
section (str | None, optional) – settings section name (Default value = None)
suppress_errors (bool, optional) – suppress logging of request errors (Default value = False)
- property session: Session
get or create session
- Returns:
created session object
- Return type:
request.Session
ahriman.core.http.sync_http_client module
- class SyncHttpClient(configuration: Configuration | None = None, section: str | None = None, *, suppress_errors: bool = False)
Bases:
LazyLogging
wrapper around requests library to reduce boilerplate
- auth
HTTP basic auth object if set
- Type:
tuple[str, str] | None
- suppress_errors
suppress logging of request errors
- Type:
bool
- timeout
HTTP request timeout in seconds
- Type:
int
default constructor
- Parameters:
configuration (Configuration | None, optional) – configuration instance (Default value = None)
section (str | None, optional) – settings section name (Default value = None)
suppress_errors (bool, optional) – suppress logging of request errors (Default value = False)
- static exception_response_text(exception: RequestException) str
safe response exception text generation
- Parameters:
exception (requests.RequestException) – exception raised
- Returns:
text of the response if it is not None and empty string otherwise
- Return type:
str
- make_request(method: Literal['DELETE', 'GET', 'POST', 'PUT'], url: str, *, headers: dict[str, str] | None = None, params: list[tuple[str, str]] | None = None, data: Any | None = None, json: dict[str, Any] | None = None, files: dict[str, tuple[str, IO[bytes], str, dict[str, str]]] | None = None, session: Session | None = None, suppress_errors: bool | None = None) Response
perform request with specified parameters
- Parameters:
method (Literal["DELETE", "GET", "POST", "PUT"]) – HTTP method to call
url (str) – remote url to call
headers (dict[str, str] | None, optional) – request headers (Default value = None)
params (list[tuple[str, str]] | None, optional) – request query parameters (Default value = None)
data (Any | None, optional) – request raw data parameters (Default value = None)
json (dict[str, Any] | None, optional) – request json parameters (Default value = None)
files (dict[str, MultipartType] | None, optional) – multipart upload (Default value = None)
session (requests.Session | None, optional) – session object if any (Default value = None)
suppress_errors (bool | None, optional) – suppress logging errors (e.g. if no web server available). If none set, the instance-wide value will be used (Default value = None)
- Returns:
response object
- Return type:
requests.Response
- property session: Session
get or create session
- Returns:
created session object
- Return type:
request.Session