gh-103606: Improve error message from logging.config.FileConfig #103628

Agent-Hellboy · 2023-04-19T12:04:07Z

Issue: Unhelpful error message from logging.config.FileConfig can be improved #103606

bedevere-bot · 2023-04-19T12:04:10Z

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

vsajip

Thanks for the PR.

Lib/logging/config.py

Lib/test/test_logging.py

bedevere-bot · 2023-04-20T07:08:43Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Agent-Hellboy · 2023-04-20T09:51:34Z

Hi @vsajip I have made the requested changes; please review again,

one more question why doesn't the module has type annotation if this is because you lack people then I would like to do this as the module is very complex and interesting

bedevere-bot · 2023-04-20T09:51:38Z

Thanks for making the requested changes!

@vsajip: please review the changes made to this pull request.

Agent-Hellboy · 2023-04-20T17:35:10Z

test on Windows is failing

ERROR: test_exception_if_confg_file_is_empty (test.test_logging.ConfigFileTest.test_exception_if_confg_file_is_empty)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "D:\a\cpython\cpython\Lib\test\test_logging.py", line 1789, in test_exception_if_confg_file_is_empty
    os.unlink(fn)
PermissionError: [WinError 32] The process cannot access the file because it is being used by another process: 'C:\\Users\\RUNNER~1\\AppData\\Local\\Temp\\test_empty_eub_b3sw.ini'

is windows runner picking random runners in between?
previously I was removing the file in cleanup but now I am removing the file in the test itself but still, the test is failing

Agent-Hellboy · 2023-04-20T19:39:28Z

test on Windows is failing

Passed

…python into fix-issue-103606

Agent-Hellboy · 2023-05-12T13:41:37Z

Hi @vsajip, please review again

Lib/logging/config.py

Lib/test/test_logging.py

bedevere-bot · 2023-05-15T07:47:05Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be poked with soft cushions!

bedevere-bot · 2023-05-16T11:53:49Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-authored-by: Vinay Sajip <[email protected]>

Agent-Hellboy · 2023-05-16T12:33:07Z

I have made the requested changes; please review again

bedevere-bot · 2023-05-16T12:33:12Z

Thanks for making the requested changes!

@vsajip: please review the changes made to this pull request.

bedevere-bot · 2023-05-17T18:25:11Z

🤖 New build scheduled with the buildbot fleet by @vsajip for commit 5fb63b0 🤖

If you want to schedule another build, you need to add the 🔨 test-with-buildbots label again.

miss-islington · 2023-05-18T04:21:31Z

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

miss-islington · 2023-05-18T04:21:34Z

Sorry, @Agent-Hellboy and @vsajip, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 152227b569c3a9b87fe0483706f704762ced6d75 3.11

bedevere-bot · 2023-05-18T04:34:54Z

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

Hi! The buildbot aarch64 RHEL8 LTO + PGO 3.x has failed when building commit 152227b.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/78/builds/4412) and take a look at the build logs.
Check if the failure is related to this commit (152227b) or if it is a false positive.
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/all/#builders/78/builds/4412

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

Click to see traceback logs

remote: Enumerating objects: 19, done.        
remote: Counting objects:   5% (1/19)        
remote: Counting objects:  10% (2/19)        
remote: Counting objects:  15% (3/19)        
remote: Counting objects:  21% (4/19)        
remote: Counting objects:  26% (5/19)        
remote: Counting objects:  31% (6/19)        
remote: Counting objects:  36% (7/19)        
remote: Counting objects:  42% (8/19)        
remote: Counting objects:  47% (9/19)        
remote: Counting objects:  52% (10/19)        
remote: Counting objects:  57% (11/19)        
remote: Counting objects:  63% (12/19)        
remote: Counting objects:  68% (13/19)        
remote: Counting objects:  73% (14/19)        
remote: Counting objects:  78% (15/19)        
remote: Counting objects:  84% (16/19)        
remote: Counting objects:  89% (17/19)        
remote: Counting objects:  94% (18/19)        
remote: Counting objects: 100% (19/19)        
remote: Counting objects: 100% (19/19), done.        
remote: Compressing objects:  10% (1/10)        
remote: Compressing objects:  20% (2/10)        
remote: Compressing objects:  30% (3/10)        
remote: Compressing objects:  40% (4/10)        
remote: Compressing objects:  50% (5/10)        
remote: Compressing objects:  60% (6/10)        
remote: Compressing objects:  70% (7/10)        
remote: Compressing objects:  80% (8/10)        
remote: Compressing objects:  90% (9/10)        
remote: Compressing objects: 100% (10/10)        
remote: Compressing objects: 100% (10/10), done.        
remote: Total 10 (delta 8), reused 1 (delta 0), pack-reused 0        
From https://github.com/python/cpython
 * branch                  main       -> FETCH_HEAD
Note: switching to '152227b569c3a9b87fe0483706f704762ced6d75'.

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 152227b569 gh-103606: Improve error message from logging.config.FileConfig (GH-103628)
Switched to and reset branch 'main'

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:2770: clean-retain-profile] Error 1 (ignored)
Python/assemble.c: In function ‘_PyAssemble_MakeCodeObject’:
Python/assemble.c:130:9: warning: ‘handler.h_startdepth’ may be used uninitialized in this function [-Wmaybe-uninitialized]
     int depth = handler->h_startdepth - 1;
         ^~~~~
Python/assemble.c:147:34: note: ‘handler.h_startdepth’ was declared here
     _PyCompile_ExceptHandlerInfo handler;
                                  ^~~~~~~
./Modules/socketmodule.c: In function ‘sock_sendmsg_afalg’:
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg_afalg’ does not match its profile data (counter ‘arcs’) [-Werror=coverage-mismatch]
 }
 ^
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg_afalg’ does not match its profile data (counter ‘single’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg_afalg’ does not match its profile data (counter ‘average’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg_afalg’ does not match its profile data (counter ‘ior’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg_afalg’ does not match its profile data (counter ‘time_profiler’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c: In function ‘sock_sendmsg’:
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg’ does not match its profile data (counter ‘arcs’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg’ does not match its profile data (counter ‘single’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg’ does not match its profile data (counter ‘average’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg’ does not match its profile data (counter ‘ior’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_sendmsg’ does not match its profile data (counter ‘time_profiler’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c: In function ‘sock_recvmsg_guts’:
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘arcs’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘single’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘indirect_call’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘average’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘ior’) [-Werror=coverage-mismatch]
./Modules/socketmodule.c:8921:1: error: the control flow of function ‘sock_recvmsg_guts’ does not match its profile data (counter ‘time_profiler’) [-Werror=coverage-mismatch]
cc1: some warnings being treated as errors
make[1]: *** [Makefile:3040: Modules/socketmodule.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:829: profile-opt] Error 2

bedevere-bot · 2023-05-18T05:01:47Z

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

Hi! The buildbot AMD64 Debian root 3.x has failed when building commit 152227b.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/345/builds/4821) and take a look at the build logs.
Check if the failure is related to this commit (152227b) or if it is a false positive.
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/all/#builders/345/builds/4821

Failed tests:

test_threading

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

==

Click to see traceback logs

remote: Enumerating objects: 19, done.        
remote: Counting objects:   5% (1/19)        
remote: Counting objects:  10% (2/19)        
remote: Counting objects:  15% (3/19)        
remote: Counting objects:  21% (4/19)        
remote: Counting objects:  26% (5/19)        
remote: Counting objects:  31% (6/19)        
remote: Counting objects:  36% (7/19)        
remote: Counting objects:  42% (8/19)        
remote: Counting objects:  47% (9/19)        
remote: Counting objects:  52% (10/19)        
remote: Counting objects:  57% (11/19)        
remote: Counting objects:  63% (12/19)        
remote: Counting objects:  68% (13/19)        
remote: Counting objects:  73% (14/19)        
remote: Counting objects:  78% (15/19)        
remote: Counting objects:  84% (16/19)        
remote: Counting objects:  89% (17/19)        
remote: Counting objects:  94% (18/19)        
remote: Counting objects: 100% (19/19)        
remote: Counting objects: 100% (19/19), done.        
remote: Compressing objects:  10% (1/10)        
remote: Compressing objects:  20% (2/10)        
remote: Compressing objects:  30% (3/10)        
remote: Compressing objects:  40% (4/10)        
remote: Compressing objects:  50% (5/10)        
remote: Compressing objects:  60% (6/10)        
remote: Compressing objects:  70% (7/10)        
remote: Compressing objects:  80% (8/10)        
remote: Compressing objects:  90% (9/10)        
remote: Compressing objects: 100% (10/10)        
remote: Compressing objects: 100% (10/10), done.        
remote: Total 10 (delta 8), reused 1 (delta 0), pack-reused 0        
From https://github.com/python/cpython
 * branch                  main       -> FETCH_HEAD
Note: switching to '152227b569c3a9b87fe0483706f704762ced6d75'.

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 152227b569 gh-103606: Improve error message from logging.config.FileConfig (GH-103628)
Switched to and reset branch 'main'

configure: WARNING: pkg-config is missing. Some dependencies may not be detected correctly.

Fatal Python error: Segmentation fault

Thread 0x00007f924aa51280 (most recent call first):
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/runner.py", line 74 in _write_status
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/runner.py", line 95 in addSuccess
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/support/testresult.py", line 122 in addSuccess
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/case.py", line 648 in run
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/case.py", line 690 in __call__
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 122 in run
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 84 in __call__
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 122 in run
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 84 in __call__
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 122 in run
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/suite.py", line 84 in __call__
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/unittest/runner.py", line 240 in run
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/support/__init__.py", line 1115 in _run_suite
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/support/__init__.py", line 1241 in run_unittest
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/runtest.py", line 294 in _test_module
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/runtest.py", line 330 in _runtest_inner2
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/runtest.py", line 373 in _runtest_inner
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/runtest.py", line 248 in _runtest
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/runtest.py", line 278 in runtest
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/main.py", line 365 in rerun_failed_tests
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/main.py", line 783 in _main
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/main.py", line 738 in main
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/libregrtest/main.py", line 802 in main
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/test/__main__.py", line 2 in <module>
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/runpy.py", line 88 in _run_code
  File "/root/buildarea/3.x.angelico-debian-amd64/build/Lib/runpy.py", line 198 in _run_module_as_main

Extension modules: _testcapi (total: 1)
Segmentation fault
make: *** [Makefile:1975: buildbottest] Error 139

Cannot open file '/root/buildarea/3.x.angelico-debian-amd64/build/test-results.xml' for upload

bedevere-bot · 2023-05-20T12:41:02Z

GH-104687 is a backport of this pull request to the 3.11 branch.

Agent-Hellboy · 2023-05-20T12:41:56Z

Hi, @miss-islington I cherry-picked it on 3.11

…pythonGH-103628) (cherry picked from commit 152227b)

gpshead · 2023-05-20T17:25:57Z

Doc/library/logging.config.rst

@@ -126,6 +130,10 @@ in :mod:`logging` itself) and defining handlers which are declared either in
    .. versionadded:: 3.10
       The *encoding* parameter is added.

+    .. versionadded:: 3.12


Strictly speaking I'd have said versionchanged rather than versionadded.

gpshead · 2023-05-20T17:27:08Z

Lib/logging/config.py

+        if not os.path.exists(fname):
+            raise FileNotFoundError(f"{fname} doesn't exist")
+        elif not os.path.getsize(fname):
+            raise ValueError(f'{fname} is an empty file')


ValueError is generally only used when the value itself is a problem, not when something external to the process such as a filesystem doesn't look right. Same below. If in doubt as to what exception to use here, I'd just go with RuntimeError if you don't have an Error exception class for your package already.

GH-103628) (#104687) * gh-103606: Improve error message from logging.config.FileConfig (GH-103628) (cherry picked from commit 152227b) plus backport the followup exception change fix to that in #104701

pythongh-103606: Improve error message from logging.config.FileConfig

78182b2

Agent-Hellboy requested a review from vsajip as a code owner April 19, 2023 12:04

bedevere-bot mentioned this pull request Apr 19, 2023

Unhelpful error message from logging.config.FileConfig can be improved #103606

Closed

bedevere-bot added the awaiting review label Apr 19, 2023

vsajip added the skip news label Apr 20, 2023

vsajip requested changes Apr 20, 2023

View reviewed changes

Lib/logging/config.py Outdated Show resolved Hide resolved

Lib/test/test_logging.py Outdated Show resolved Hide resolved

bedevere-bot removed the awaiting review label Apr 20, 2023

bedevere-bot added the awaiting changes label Apr 20, 2023

Agent-Hellboy added 2 commits April 20, 2023 14:27

pythongh-103606: Improve error message from logging.config.FileConfig

2c08f30

Merge branch 'python:main' into fix-issue-103606

091cfc5

bedevere-bot added awaiting change review and removed awaiting changes labels Apr 20, 2023

bedevere-bot requested a review from vsajip April 20, 2023 09:51

Agent-Hellboy force-pushed the fix-issue-103606 branch 2 times, most recently from 3260bb8 to 64d7142 Compare April 20, 2023 17:05

Agent-Hellboy force-pushed the fix-issue-103606 branch from 64d7142 to 5a6afbb Compare April 20, 2023 18:18

Merge branch 'fix-issue-103606' of https://github.com/Agent-Hellboy/c…

467f639

…python into fix-issue-103606

Agent-Hellboy force-pushed the fix-issue-103606 branch from 5a6afbb to 467f639 Compare April 21, 2023 04:35

Merge branch 'main' into fix-issue-103606

6ecfad7

vsajip requested changes May 15, 2023

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting change review labels May 15, 2023

bedevere-bot removed the awaiting change review label May 16, 2023

bedevere-bot added the awaiting changes label May 16, 2023

Agent-Hellboy and others added 2 commits May 16, 2023 17:50

fix doc

340b860

Update Doc/library/logging.config.rst

5fb63b0

Co-authored-by: Vinay Sajip <[email protected]>

bedevere-bot added awaiting change review and removed awaiting changes labels May 16, 2023

bedevere-bot requested a review from vsajip May 16, 2023 12:33

vsajip approved these changes May 17, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels May 17, 2023

vsajip added the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 17, 2023

bedevere-bot removed the 🔨 test-with-buildbots Test PR w/ buildbots; report in status section label May 17, 2023

vsajip merged commit 152227b into python:main May 18, 2023

bedevere-bot removed the awaiting merge label May 18, 2023

vsajip added the needs backport to 3.11 only security fixes label May 18, 2023

miss-islington assigned vsajip May 18, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label May 20, 2023

Agent-Hellboy added a commit to Agent-Hellboy/cpython that referenced this pull request May 20, 2023

pythongh-103606: Improve error message from logging.config.FileConfig (…

0c1f304

…pythonGH-103628) (cherry picked from commit 152227b)

gpshead reviewed May 20, 2023

View reviewed changes

Uh oh!

gh-103606: Improve error message from logging.config.FileConfig #103628

gh-103606: Improve error message from logging.config.FileConfig #103628

Uh oh!

Conversation

Agent-Hellboy commented Apr 19, 2023 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-bot commented Apr 19, 2023

Uh oh!

vsajip left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Apr 20, 2023

Uh oh!

Agent-Hellboy commented Apr 20, 2023

Uh oh!

bedevere-bot commented Apr 20, 2023

Uh oh!

Agent-Hellboy commented Apr 20, 2023

Uh oh!

Agent-Hellboy commented Apr 20, 2023

Uh oh!

Agent-Hellboy commented May 12, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented May 15, 2023

Uh oh!

bedevere-bot commented May 16, 2023

Uh oh!

Agent-Hellboy commented May 16, 2023

Uh oh!

bedevere-bot commented May 16, 2023

Uh oh!

bedevere-bot commented May 17, 2023

Uh oh!

miss-islington commented May 18, 2023

Uh oh!

miss-islington commented May 18, 2023

Uh oh!

bedevere-bot commented May 18, 2023

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

Uh oh!

bedevere-bot commented May 18, 2023

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

Uh oh!

bedevere-bot commented May 20, 2023

Uh oh!

Agent-Hellboy commented May 20, 2023

Uh oh!

gpshead May 20, 2023

Choose a reason for hiding this comment

Uh oh!

gpshead May 20, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Agent-Hellboy commented Apr 19, 2023 •

edited by bedevere-bot

Loading