summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBénédikt Tran <10796600+picnixz@users.noreply.github.com>2024-10-07 18:42:19 (GMT)
committerGitHub <noreply@github.com>2024-10-07 18:42:19 (GMT)
commit7ffe94fb242fd51bb07c7f0d31e94efeea3619d4 (patch)
treebb549321720006985d642a1ade84a3180fdc542f /Doc
parent03775472cc69e150ced22dc30334a7a202fc0380 (diff)
downloadcpython-7ffe94fb242fd51bb07c7f0d31e94efeea3619d4.zip
cpython-7ffe94fb242fd51bb07c7f0d31e94efeea3619d4.tar.gz
cpython-7ffe94fb242fd51bb07c7f0d31e94efeea3619d4.tar.bz2
gh-124653: Relax (again) detection of queue API for logging handlers (GH-124897)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/logging.config.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 317ca87..0e9dc33 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -753,16 +753,17 @@ The ``queue`` and ``listener`` keys are optional.
If the ``queue`` key is present, the corresponding value can be one of the following:
-* An object implementing the :class:`queue.Queue` public API. For instance,
- this may be an actual instance of :class:`queue.Queue` or a subclass thereof,
- or a proxy obtained by :meth:`multiprocessing.managers.SyncManager.Queue`.
+* An object implementing the :meth:`Queue.put_nowait <queue.Queue.put_nowait>`
+ and :meth:`Queue.get <queue.Queue.get>` public API. For instance, this may be
+ an actual instance of :class:`queue.Queue` or a subclass thereof, or a proxy
+ obtained by :meth:`multiprocessing.managers.SyncManager.Queue`.
This is of course only possible if you are constructing or modifying
the configuration dictionary in code.
* A string that resolves to a callable which, when called with no arguments, returns
- the :class:`queue.Queue` instance to use. That callable could be a
- :class:`queue.Queue` subclass or a function which returns a suitable queue instance,
+ the queue instance to use. That callable could be a :class:`queue.Queue` subclass
+ or a function which returns a suitable queue instance,
such as ``my.module.queue_factory()``.
* A dict with a ``'()'`` key which is constructed in the usual way as discussed in