Make it explicit that logging QueueHandler / QueueListener accepts a SimpleQueue.

[mjpieters]

BPO	37469
Nosy	@vsajip, @mjpieters
PRs	bpo-37469: Document usability of SimpleQueue with QueueHandler and Qu… #14521 [3.8] bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) #14525 [3.7] bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) #14526

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-07-01.18:54:32.802>
created_at = <Date 2019-07-01.13:41:45.060>
labels = ['3.7', '3.8', '3.9', 'docs']
title = 'Make it explicit that logging QueueHandler / QueueListener accepts a SimpleQueue.'
updated_at = <Date 2019-07-01.18:54:32.798>
user = 'https://github.com/mjpieters'

bugs.python.org fields:

activity = <Date 2019-07-01.18:54:32.798>
actor = 'vinay.sajip'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-07-01.18:54:32.802>
closer = 'vinay.sajip'
components = ['Documentation']
creation = <Date 2019-07-01.13:41:45.060>
creator = 'mjpieters'
dependencies = []
files = []
hgrepos = []
issue_num = 37469
keywords = ['patch']
message_count = 4.0
messages = ['347017', '347052', '347062', '347063']
nosy_count = 3.0
nosy_names = ['vinay.sajip', 'mjpieters', 'docs@python']
pr_nums = ['14521', '14525', '14526']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue37469'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

[mjpieters]

The implementation of the logging.handler.QueueHandler and logging.handler.QueueListener does not make use of the task tracking API of queues (queue.task_done(), queue.join()) nor does it care if the queue is unbounded (queue.full(), catching the Full exception).

As such, it can work just as well with the new queue.SimpleQueue implementation (new in 3.7, see https://docs.python.org/3/library/queue.html#queue.SimpleQueue), which is fast and lightweight, implemented in C.

Can the documentation be updated to make this option explicit?

[vsajip]

New changeset e6b64b7 by Vinay Sajip in branch 'master':
bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521)
e6b64b7

[vsajip]

New changeset b0ab95b by Vinay Sajip (Miss Islington (bot)) in branch '3.7':
bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) (GH-14526)
b0ab95b

[vsajip]

New changeset 6cde613 by Vinay Sajip (Miss Islington (bot)) in branch '3.8':
bpo-37469: Document usability of SimpleQueue with QueueHandler and QueueListener. (GH-14521) (GH-14525)
6cde613