Skip to content

gh-124653: relax (again) detection of queue API for logging handlers #124897

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
vsajip merged 8 commits into from
Oct 7, 2024
Merged

gh-124653: relax (again) detection of queue API for logging handlers #124897

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d93b5f4
Relax constraints on the Queue API checks for logging.
picnixz Oct 2, 2024
43872bc
update docs
picnixz Oct 2, 2024
52a456a
blurb
picnixz Oct 2, 2024
fe6c25d
fix test
picnixz Oct 2, 2024
985d3c3
fortify tests
picnixz Oct 2, 2024
87379b1
update comments
picnixz Oct 2, 2024
c1d1f16
fix WASI tests
picnixz Oct 2, 2024
e2323ee
Update Lib/test/test_logging.py
picnixz Oct 5, 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
Prev Previous commit
Next Next commit
fix WASI tests
  • Loading branch information
@picnixz
picnixz committed Oct 2, 2024
commit c1d1f16ddcdc391f0ffc7bdafcf1454e41816956
72 changes: 35 additions & 37 deletions Lib/test/test_logging.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3952,14 +3952,23 @@ def test_config_queue_handler(self):
msg = str(ctx.exception)
self.assertEqual(msg, "Unable to configure handler 'ah'")

def _apply_simple_queue_listener_configuration(self, qspec):
self.apply_config({
"version": 1,
"handlers": {
"queue_listener": {
"class": "logging.handlers.QueueHandler",
"queue": qspec,
},
},
})

@threading_helper.requires_working_threading()
@support.requires_subprocess()
@patch("multiprocessing.Manager")
def test_config_queue_handler_does_not_create_multiprocessing_manager(self, manager):
# gh-120868, gh-121723, gh-124653

import multiprocessing

for qspec in [
{"()": "queue.Queue", "maxsize": -1},
queue.Queue(),
Expand All @@ -3972,52 +3981,41 @@ def test_config_queue_handler_does_not_create_multiprocessing_manager(self, mana
# check that the queue object correctly implements the API.
CustomQueueFakeProtocol(),
MinimalQueueProtocol(),
# multiprocessing.Queue() is a valid queue for the logging module
# but multiprocessing.SimpleQueue() is NOT valid because it lacks
# the 'put_nowait' method needed by the logging queue handler.
multiprocessing.Queue(),
]:
with self.subTest(qspec=qspec):
self.apply_config(
{
"version": 1,
"handlers": {
"queue_listener": {
"class": "logging.handlers.QueueHandler",
"queue": qspec,
},
},
}
)
self._apply_simple_queue_listener_configuration(qspec)
manager.assert_not_called()

@patch("multiprocessing.Manager")
def test_config_queue_handler_invalid_config_does_not_create_multiprocessing_manager(self, manager):
# gh-120868, gh-121723, gh-124653

for qspec in [object(), CustomQueueWrongProtocol()]:
with self.subTest(qspec=qspec), self.assertRaises(ValueError):
self._apply_simple_queue_listener_configuration(qspec)
manager.assert_not_called()

@skip_if_tsan_fork
@support.requires_subprocess()
@unittest.skipUnless(support.Py_DEBUG, "requires a debug build for testing"
" assertions in multiprocessing")
def test_config_reject_simple_queue_handler_multiprocessing_context(self):
# multiprocessing.SimpleQueue does not implement 'put_nowait'
# and thus cannot be used as a queue-like object (gh-124653)

import multiprocessing

for qspec in [
object(),
CustomQueueWrongProtocol(),
# multiprocessing.SimpleQueue does not implement the 'put_nowait'
# method and thus cannot be used as a queue-like object here.
multiprocessing.SimpleQueue(),
]:
with self.subTest(qspec=qspec):
if support.MS_WINDOWS:
start_methods = ['spawn']
else:
start_methods = ['spawn', 'fork', 'forkserver']

for start_method in start_methods:
with self.subTest(start_method=start_method):
ctx = multiprocessing.get_context(start_method)
qspec = ctx.SimpleQueue()
with self.assertRaises(ValueError):
self.apply_config(
{
"version": 1,
"handlers": {
"queue_listener": {
"class": "logging.handlers.QueueHandler",
"queue": qspec,
},
},
}
)
manager.assert_not_called()
self._apply_simple_queue_listener_configuration(qspec)

@skip_if_tsan_fork
@support.requires_subprocess()
Expand Down