mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
Add Usage block to RequestHandler
This commit is contained in:
parent
71b20ae6f6
commit
9aee0b1d79
1 changed files with 11 additions and 0 deletions
|
|
@ -92,6 +92,17 @@ class RequestHandler:
|
||||||
conversion of standard HTTP errors to beets-specific exceptions. Supports
|
conversion of standard HTTP errors to beets-specific exceptions. Supports
|
||||||
custom session types and error mappings that can be overridden by
|
custom session types and error mappings that can be overridden by
|
||||||
subclasses.
|
subclasses.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
Subclass and override :class:`RequestHandler.session_type`,
|
||||||
|
:class:`RequestHandler.explicit_http_errors` or
|
||||||
|
:class:`RequestHandler.status_to_error()` to customize behavior.
|
||||||
|
|
||||||
|
Use :class:`RequestHandler.get()` or
|
||||||
|
:class:`RequestHandler.fetch_json()` for common operations, or
|
||||||
|
:class:`RequestHandler.request()` for full control over HTTP methods.
|
||||||
|
|
||||||
|
Feel free to define common methods that are used in multiple plugins.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
session_type: ClassVar[type[TimeoutSession]] = TimeoutSession
|
session_type: ClassVar[type[TimeoutSession]] = TimeoutSession
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue