Skip to content

Update logging.config.listen() docstrings to mention dictConfig() #155479

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

Open
lpyu001 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −5
Open

Update logging.config.listen() docstrings to mention dictConfig() #155479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions Lib/logging/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,8 +934,9 @@ def listen(port=DEFAULT_LOGGING_CONFIG_PORT, verify=None):
Start up a socket server on the specified port, and listen for new
configurations.

These will be sent as a file suitable for processing by fileConfig().
Returns a Thread object on which you can call start() to start the server,
These will be sent as a file suitable for processing by dictConfig() or
fileConfig(). Returns a Thread object on which you can call start() to
start the server,
and which you can join() when appropriate. To stop the server, call
stopListening().

Expand All @@ -953,16 +954,16 @@ class ConfigStreamHandler(StreamRequestHandler):
"""
Handler for a logging configuration request.

It expects a completely new logging configuration and uses fileConfig
to install it.
It expects a completely new logging configuration and uses dictConfig
or fileConfig to install it.
"""
def handle(self):
"""
Handle a request.

Each request is expected to be a 4-byte length, packed using
struct.pack(">L", n), followed by the config file.
Uses fileConfig() to do the grunt work.
Uses dictConfig() or fileConfig() to do the grunt work.
"""
try:
conn = self.connection
Expand Down
Loading