8000 gh-121723: Relax constraints on queue objects for `logging.handlers.QueueHandler`. by picnixz · Pull Request #122154 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-121723: Relax constraints on queue objects for logging.handlers.QueueHandler. #122154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Aug 2, 2024
Merged

gh-121723: Relax constraints on queue objects for logging.handlers.QueueHandler. #122154

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6ab2257
Relax constraints on queue objects for queue handlers.
picnixz Jul 23, 2024
9af323b
add tests
picnixz Jul 23, 2024
78936a1
update docs
picnixz Jul 23, 2024
5fc3d5a
blurb
picnixz Jul 23, 2024
04c7813
refactor into a helper
picnixz Jul 24, 2024
e5cdb1c
add regression test
picnixz Jul 24, 2024
b770787
fix start methods selection on MS-Windows
picnixz Jul 24, 2024
65a8987
fixup refs
picnixz Jul 24, 2024
7729fb6
increase the timeout (maybe it works like this?)
picnixz Jul 24, 2024
57d7190
fixup! typos
picnixz Jul 28, 2024
e4800c4
fixup! typos
picnixz Jul 28, 2024
bd12893
reduce line numbers
picnixz Jul 28, 2024
70d69e5
renaming
picnixz Jul 28, 2024
d6b6ef3
fixup! refs
picnixz Jul 29, 2024
d2bfdc2
increase timeout (again)
picnixz Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Relax constraints on queue objects for queue handlers. 
Any object implementing the Queue public API can be used
for configuring a QueueHandler. Only the presence of the
methods is checked, but not their signature.
  • Loading branch information
@picnixz
picnixz committed Jul 23, 2024
commit 6ab2257ec5d5fc5e7b129489f1430b6b973bf0d5
43 changes: 21 additions & 22 deletions Lib/logging/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,31 +791,30 @@ def configure_handler(self, config):
if '()' not in qspec:
raise TypeError('Invalid queue specifier %r' % qspec)
config['queue'] = self.configure_custom(dict(qspec))
elif isinstance(qspec, queue.Queue):
pass
else:
# defer importing multiprocessing as much as possible
from multiprocessing.queues import Queue as MPQueue

if not isinstance(qspec, (queue.Queue, MPQueue)):
# Safely check if 'qspec' is an instance of Manager.Queue
# / Manager.JoinableQueue

from multiprocessing import Manager as MM
from multiprocessing.managers import BaseProxy

# if it's not an instance of BaseProxy, it also can't be
# an instance of Manager.Queue / Manager.JoinableQueue
if isinstance(qspec, BaseProxy):
# Sometimes manager or queue creation might fail
# (e.g. see issue gh-120868). In that case, any
# exception during the creation of these queues will
# propagate up to the caller and be wrapped in a
# `ValueError`, whose cause will indicate the details of
# the failure.
mm = MM()
proxy_queue = mm.Queue()
proxy_joinable_queue = mm.JoinableQueue()
if not isinstance(qspec, (type(proxy_queue), type(proxy_joinable_queue))):
raise TypeError('Invalid queue specifier %r' % qspec)
else:
if not isinstance(qspec, MPQueue):
# Depending on the multiprocessing context,
# we cannot create a Manager instance here
# to get the runtime type of Manager.Queue()
# or Manager.JoinableQueue() (see gh-121723).
#
# Since we only need to support an object
# implementing the Queue API (see gh-120868),
# we only do a protocol check but do not rely
# on typing.runtime_checkable and typing.Protocol
# to reduce import time.
queue_interface = [
'empty', 'full', 'get', 'get_nowait',
'put', 'put_nowait', 'join', 'qsize',
'task_done',
]
if not all(callable(getattr(qspec, method, None))
for method in queue_interface):
raise TypeError('Invalid queue specifier %r' % qspec)

if 'listener' in config:
Expand Down
0