summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaundur <kaundur@protonmail.com>2024-06-04 11:48:05 (GMT)
committerGitHub <noreply@github.com>2024-06-04 11:48:05 (GMT)
commitdce14bb2dce7887df40ae5c13b0d13e0dafceff7 (patch)
tree0b785f5cc4f04ae181f65979dd8a941eccc1f67e
parent9e052619a6d32051394444c24d3185db1735a893 (diff)
downloadcpython-dce14bb2dce7887df40ae5c13b0d13e0dafceff7.zip
cpython-dce14bb2dce7887df40ae5c13b0d13e0dafceff7.tar.gz
cpython-dce14bb2dce7887df40ae5c13b0d13e0dafceff7.tar.bz2
gh-118868: logging QueueHandler fix passing of kwargs (GH-118869)
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
-rw-r--r--Lib/logging/config.py16
-rw-r--r--Lib/test/test_logging.py29
-rw-r--r--Misc/NEWS.d/next/Library/2024-05-09-21-36-11.gh-issue-118868.uckxxP.rst2
3 files changed, 39 insertions, 8 deletions
diff --git a/Lib/logging/config.py b/Lib/logging/config.py
index 860e475..ac45d68 100644
--- a/Lib/logging/config.py
+++ b/Lib/logging/config.py
@@ -725,16 +725,16 @@ class DictConfigurator(BaseConfigurator):
def _configure_queue_handler(self, klass, **kwargs):
if 'queue' in kwargs:
- q = kwargs['queue']
+ q = kwargs.pop('queue')
else:
q = queue.Queue() # unbounded
- rhl = kwargs.get('respect_handler_level', False)
- if 'listener' in kwargs:
- lklass = kwargs['listener']
- else:
- lklass = logging.handlers.QueueListener
- listener = lklass(q, *kwargs.get('handlers', []), respect_handler_level=rhl)
- handler = klass(q)
+
+ rhl = kwargs.pop('respect_handler_level', False)
+ lklass = kwargs.pop('listener', logging.handlers.QueueListener)
+ handlers = kwargs.pop('handlers', [])
+
+ listener = lklass(q, *handlers, respect_handler_level=rhl)
+ handler = klass(q, **kwargs)
handler.listener = listener
return handler
diff --git a/Lib/test/test_logging.py b/Lib/test/test_logging.py
index 97d7c9f..9ebd345 100644
--- a/Lib/test/test_logging.py
+++ b/Lib/test/test_logging.py
@@ -3976,6 +3976,35 @@ class ConfigDictTest(BaseTest):
}
logging.config.dictConfig(config)
+ # gh-118868: check if kwargs are passed to logging QueueHandler
+ def test_kwargs_passing(self):
+ class CustomQueueHandler(logging.handlers.QueueHandler):
+ def __init__(self, *args, **kwargs):
+ super().__init__(queue.Queue())
+ self.custom_kwargs = kwargs
+
+ custom_kwargs = {'foo': 'bar'}
+
+ config = {
+ 'version': 1,
+ 'handlers': {
+ 'custom': {
+ 'class': CustomQueueHandler,
+ **custom_kwargs
+ },
+ },
+ 'root': {
+ 'level': 'DEBUG',
+ 'handlers': ['custom']
+ }
+ }
+
+ logging.config.dictConfig(config)
+
+ handler = logging.getHandlerByName('custom')
+ self.assertEqual(handler.custom_kwargs, custom_kwargs)
+
+
class ManagerTest(BaseTest):
def test_manager_loggerclass(self):
logged = []
diff --git a/Misc/NEWS.d/next/Library/2024-05-09-21-36-11.gh-issue-118868.uckxxP.rst b/Misc/NEWS.d/next/Library/2024-05-09-21-36-11.gh-issue-118868.uckxxP.rst
new file mode 100644
index 0000000..372a809
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-05-09-21-36-11.gh-issue-118868.uckxxP.rst
@@ -0,0 +1,2 @@
+Fixed issue where kwargs were no longer passed to the logging handler
+QueueHandler