Skip to content

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

Merged
vsajip merged 1 commit into
python:mainfrom
lpyu001:logging-config-docstring
Aug 10, 2026
Merged

Update logging.config.listen() docstrings to mention dictConfig()#155479
vsajip merged 1 commit into
python:mainfrom
lpyu001:logging-config-docstring

Conversation

@lpyu001

@lpyu001 lpyu001 commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

The logging.config.listen() docstring only mentions fileConfig(),but the implementation first attempts to process JSON configurations using dictConfig() and falls back to fileConfig().

Update the public docstring and the two related local docstrings to describe both supported configuration mechanisms.

@lpyu001
lpyu001 requested a review from vsajip as a code owner August 10, 2026 10:16
@aisk aisk added the skip news label Aug 10, 2026
@aisk aisk changed the title logging.config.listen() docstring omits dictConfig() support Update logging.config.listen() docstrings to mention dictConfig() Aug 10, 2026
@vsajip
vsajip merged commit 791b573 into python:main Aug 10, 2026
63 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Aug 10, 2026
@lpyu001

lpyu001 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

This also affects the 3.13, 3.14, and 3.15 branches. Should this be backported to these branches as well? @vsajip

@aisk aisk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 11, 2026
@miss-islington-app

Copy link
Copy Markdown

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

@miss-islington-app

Copy link
Copy Markdown

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

@miss-islington-app

Copy link
Copy Markdown

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

@bedevere-app

bedevere-app Bot commented Aug 11, 2026

Copy link
Copy Markdown

GH-155528 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 11, 2026
@bedevere-app

bedevere-app Bot commented Aug 11, 2026

Copy link
Copy Markdown

GH-155529 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 Aug 11, 2026
@bedevere-app

bedevere-app Bot commented Aug 11, 2026

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 11, 2026
vsajip pushed a commit that referenced this pull request Aug 12, 2026
vsajip pushed a commit that referenced this pull request Aug 12, 2026
@bedevere-bot

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable LTO + PGO 3.13 (tier-2) has failed when building commit fdf830d.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1433/builds/1266) and take a look at the build logs.
  4. Check if the failure is related to this commit (fdf830d) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1433/builds/1266

Summary of the results of the build (if available):

Click to see traceback logs
Note: switching to 'fdf830d91c2a08dc7ec4019da02d2ced1941798d'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at fdf830d91c2a0 [3.13] Update logging.config.listen() docstrings to mention dictConfig() (GH-155479) (GH-155528)
Switched to and reset branch '3.13'

find: ‘build’: No such file or directory
find: ‘build’: No such file or directory
find: ‘build’: No such file or directory
find: ‘build’: No such file or directory
make[2]: [Makefile:3132: clean-retain-profile] Error 1 (ignored)
In function ‘hashtable_key_from_2_strings’,
    inlined from ‘_extensions_cache_find_unlocked’ at Python/import.c:1284:17:
Python/import.c:1197:5: warning: ‘strncpy’ output truncated before terminating nul copying as many bytes from a string as its length [-Wstringop-truncation]
 1197 |     strncpy(key, str1_data, str1_len);
      |     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python/import.c:1183:27: note: length computed here
 1183 |     Py_ssize_t str1_len = strlen(str1_data);
      |                           ^~~~~~~~~~~~~~~~~
./Modules/socketmodule.c: In function ‘getsockaddrarg’:
./Modules/socketmodule.c:2528:9: warning: ‘strncpy’ specified bound 64 equals destination size [-Wstringop-truncation]
 2528 |         strncpy((char *)sa->salg_name, name, sizeof(sa->salg_name));
      |         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ar: libpython3.13.a: error reading Modules/posixmodule.o: No space left on device
make[2]: *** [Makefile:1065: libpython3.13.a] Error 1
make[1]: *** [Makefile:895: profile-gen-stamp] Error 2
make: *** [Makefile:907: profile-run-stamp] Error 2

@bedevere-bot

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable LTO 3.13 (tier-2) has failed when building commit fdf830d.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1399/builds/1231) and take a look at the build logs.
  4. Check if the failure is related to this commit (fdf830d) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1399/builds/1231

Summary of the results of the build (if available):

Click to see traceback logs
Note: switching to 'fdf830d91c2a08dc7ec4019da02d2ced1941798d'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at fdf830d91c2a [3.13] Update logging.config.listen() docstrings to mention dictConfig() (GH-155479) (GH-155528)
Switched to and reset branch '3.13'

In function ‘hashtable_key_from_2_strings’,
    inlined from ‘_extensions_cache_find_unlocked’ at Python/import.c:1284:17:
Python/import.c:1197:5: warning: ‘strncpy’ output truncated before terminating nul copying as many bytes from a string as its length [-Wstringop-truncation]
 1197 |     strncpy(key, str1_data, str1_len);
      |     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Python/import.c:1183:27: note: length computed here
 1183 |     Py_ssize_t str1_len = strlen(str1_data);
      |                           ^~~~~~~~~~~~~~~~~
ar: libpython3.13.a: error reading Python/context.o: No space left on device
make: *** [Makefile:1065: libpython3.13.a] Error 1

@bedevere-bot

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable 3.14 (tier-2) has failed when building commit d755701.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1750/builds/787) and take a look at the build logs.
  4. Check if the failure is related to this commit (d755701) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1750/builds/787

Summary of the results of the build (if available):

Click to see traceback logs
Note: switching to 'd755701b2aa35d7ec05f16fea410191f034e85c1'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at d755701b2aa35 [3.14] Update logging.config.listen() docstrings to mention dictConfig() (GH-155479) (GH-155529)
Switched to and reset branch '3.14'

/usr/bin/ld: final link failed: No space left on device
collect2: error: ld returned 1 exit status
make: *** [Makefile:1934: Programs/_freeze_module] Error 1

@bedevere-bot

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable Clang 3.14 (tier-2) has failed when building commit d755701.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1785/builds/771) and take a look at the build logs.
  4. Check if the failure is related to this commit (d755701) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1785/builds/771

Summary of the results of the build (if available):

Click to see traceback logs
Note: switching to 'd755701b2aa35d7ec05f16fea410191f034e85c1'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at d755701b2aa35 [3.14] Update logging.config.listen() docstrings to mention dictConfig() (GH-155479) (GH-155529)
Switched to and reset branch '3.14'

/usr/bin/ld: final link failed: No space left on device
clang: error: linker command failed with exit code 1 (use -v to see invocation)
make: *** [Makefile:1934: Programs/_freeze_module] Error 1

@bedevere-bot

Copy link
Copy Markdown

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD Refleaks 3.13 (tier-3) has failed when building commit fdf830d.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1615/builds/1913) and take a look at the build logs.
  4. Check if the failure is related to this commit (fdf830d) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1615/builds/1913

Failed tests:

  • test_httpservers

Failed subtests:

  • test_large_content_length_truncated - test.test_httpservers.CGIHTTPServerTestCase.test_large_content_length_truncated

Summary of the results of the build (if available):

==

Click to see traceback logs
Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/test/test_httpservers.py", line 1030, in test_large_content_length_truncated
    res = self.request('/cgi-bin/file1.py', 'POST', b'x', headers)
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/test/test_httpservers.py", line 89, in request
    return self.connection.getresponse()
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/http/client.py", line 1478, in getresponse
    response.begin()
    ~~~~~~~~~~~~~~^^
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/http/client.py", line 343, in begin
    version, status, reason = self._read_status()
                              ~~~~~~~~~~~~~~~~~^^
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/http/client.py", line 304, in _read_status
    line = str(self.fp.readline(_MAXLINE + 1), "iso-8859-1")
               ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14.refleak/build/Lib/socket.py", line 723, in readinto
    return self._sock.recv_into(b)
           ~~~~~~~~~~~~~~~~~~~~^^^
ConnectionResetError: [Errno 54] Connection reset by peer

mbeijen pushed a commit to mbeijen/cpython that referenced this pull request Aug 14, 2026
…thonGH-155479)

logging.config.listen() docstring had omitted dictConfig() support.
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.

4 participants