Skip to content

Commit 9aee0b1

Browse files
committed
Add Usage block to RequestHandler
1 parent 71b20ae commit 9aee0b1

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

beetsplug/_utils/requests.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,17 @@ class RequestHandler:
9292
conversion of standard HTTP errors to beets-specific exceptions. Supports
9393
custom session types and error mappings that can be overridden by
9494
subclasses.
95+
96+
Usage:
97+
Subclass and override :class:`RequestHandler.session_type`,
98+
:class:`RequestHandler.explicit_http_errors` or
99+
:class:`RequestHandler.status_to_error()` to customize behavior.
100+
101+
Use :class:`RequestHandler.get()` or
102+
:class:`RequestHandler.fetch_json()` for common operations, or
103+
:class:`RequestHandler.request()` for full control over HTTP methods.
104+
105+
Feel free to define common methods that are used in multiple plugins.
95106
"""
96107

97108
session_type: ClassVar[type[TimeoutSession]] = TimeoutSession

0 commit comments

Comments
 (0)