Base

class lanyard.http.base.BaseHTTP(base_url, raise_for_status=True, timeout=None)

The base abstract class for all HTTP-related classes.

Parameters:

• base_url (str) – Base URL of HTTP response (example: https://api.lanyard.rest/).

• raise_for_status (bool) – Raise HTTP status code of HTTP response (example: True).

• timeout (float | None) – Timeout for HTTP requests (example: None).

async get(path=None, params=None, headers=None, **kwargs)

Executes an async HTTP GET request.

Parameters:

• path (str | None) – URL for request.

• params (str | Dict[str, Any] | None) – Query parameters to include in the URL.

• headers (Dict[str, Any] | None) – Headers to include in the request.

• kwargs (Any) – Additional fields for HTTP client attributes.

Return type:

HTTPResponse

async put(path=None, data=None, params=None, headers=None, **kwargs)

Executes an async HTTP PUT request.

Parameters:

• path (str | None) – URL for request.

• data (str | bytes | Dict[str, Any] | None) – Body of request to include in the request.

• params (str | Dict[str, Any] | None) – Query parameters to include in the URL.

• headers (Dict[str, Any] | None) – Headers to include in the request.

• kwargs (Any) – Additional fields for HTTP client attributes.

Return type:

HTTPResponse

async patch(path=None, data=None, params=None, headers=None, **kwargs)

Executes an async HTTP PATCH request.

Parameters:

• path (str | None) – URL for request.

• data (str | bytes | Dict[str, Any] | None) – Body of request to include in the request.

• params (str | Dict[str, Any] | None) – Query parameters to include in the URL.

• headers (Dict[str, Any] | None) – Headers to include in the request.

• kwargs (Any) – Additional fields for HTTP client attributes.

Return type:

HTTPResponse

async delete(path=None, params=None, headers=None, **kwargs)

Executes an async HTTP DELETE request.

Parameters:

• path (str | None) – URL for request.

• params (str | Dict[str, Any] | None) – Query parameters to include in the URL.

• headers (Dict[str, Any] | None) – Headers to include in the request.

• kwargs (Any) – Additional fields for HTTP client attributes.

Return type:

HTTPResponse