Skip to content

Doc: Correct logging HOWTO and cookbook - #162198

Merged
vsajip merged 1 commit into
python:mainfrom
methane:fix-howto-logging
Nov 19, 2026
Merged

vsajip merged 1 commit into
python:mainfrom
methane:fix-howto-logging

Conversation

@methane

@methane methane commented Nov 18, 2026

Copy link
Copy Markdown
Member
  • Explain why the stdout handler needs a filter: its INFO threshold also admits ERROR and CRITICAL records.
  • Correct the handler descriptions: QueueHandler calls handleError when a bounded queue is full, RotatingFileHandler removes the oldest backup before renaming the others, and HTTPHandler sends URL-encoded data.
  • Remove two suggestions that do not work: NullHandler never runs its filters, and SocketHandler converts the message to a string before pickling the record.
  • Fix the ZeroMQ listener to consume its own ctx argument and honor the block argument to dequeue().
  • Check the multiprocessing start method because only fork inherits the parent's setup logger in this example.
  • Clarify that the multiline recipe splits the message after substituting its arguments.
  • Remove the Python 3.9 note that incorrectly refers readers to open() for the default encoding error handler.
  • List all four logging keyword arguments and identify the BufferingFormatter methods for customizing batch headers and footers.

@methane methane added the docs Documentation in the Doc dir label Nov 18, 2026
@methane
methane requested a review from vsajip as a code owner November 18, 2026 07:48
@methane methane added skip issue skip news needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Nov 18, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Nov 18, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35977618 | 📁 Comparing 8816b71 against main (9427640)

  🔍 Preview build  

2 files changed
± howto/logging-cookbook.html
± howto/logging.html

@vsajip
vsajip merged commit b0ccebc into python:main Nov 19, 2026
47 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Nov 19, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @methane for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Nov 19, 2026

Copy link
Copy Markdown

GH-162277 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Nov 19, 2026
@bedevere-app

bedevere-app Bot commented Nov 19, 2026

Copy link
Copy Markdown

GH-162278 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Nov 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants