From 9dad0409771ef0ac4606eea98f65a93c2cd8c7da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0ar=C5=ABnas=20Nejus?= Date: Fri, 19 Dec 2025 13:43:06 +0000 Subject: [PATCH] Add Usage block to RequestHandler --- beetsplug/_utils/requests.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/beetsplug/_utils/requests.py b/beetsplug/_utils/requests.py index b45efd780..0321b5ad6 100644 --- a/beetsplug/_utils/requests.py +++ b/beetsplug/_utils/requests.py @@ -92,6 +92,18 @@ class RequestHandler: conversion of standard HTTP errors to beets-specific exceptions. Supports custom session types and error mappings that can be overridden by 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_json()` to get JSON response data + * :class:`RequestHandler.get()` to get HTTP response object + * :class:`RequestHandler.request()` to invoke arbitrary HTTP methods + + Feel free to define common methods that are used in multiple plugins. """ session_type: ClassVar[type[TimeoutSession]] = TimeoutSession