Thanks to visit codestin.com
Credit goes to github.com

Skip to content

GH-113421: Fix multiprocessing logger #113423

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

Merged
serhiy-storchaka merged 8 commits into from
Dec 24, 2023
Merged

GH-113421: Fix multiprocessing logger #113423

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
772a742
Fix multiprocessing logger
xu-song Dec 23, 2023
0c71144
add news entry
xu-song Dec 23, 2023
493414b
Add format unittest for multiprocessing logger
xu-song Dec 23, 2023
5313957
Initialize handler with io.StringIO()
xu-song Dec 23, 2023
f42181a
Add assert; Remove handler after test
xu-song Dec 24, 2023
9705a0b
Add try finnaly block; Restore logger level
xu-song Dec 24, 2023
04509a7
remove unused import
xu-song Dec 24, 2023
a49b399
Simplify unittest
xu-song Dec 24, 2023
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
8 changes: 4 additions & 4 deletions Lib/multiprocessing/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@

def sub_debug(msg, *args):
if _logger:
_logger.log(SUBDEBUG, msg, *args)
_logger.log(SUBDEBUG, msg, *args, stacklevel=2)

def debug(msg, *args):
if _logger:
_logger.log(DEBUG, msg, *args)
_logger.log(DEBUG, msg, *args, stacklevel=2)

def info(msg, *args):
if _logger:
_logger.log(INFO, msg, *args)
_logger.log(INFO, msg, *args, stacklevel=2)

def sub_warning(msg, *args):
if _logger:
_logger.log(SUBWARNING, msg, *args)
_logger.log(SUBWARNING, msg, *args, stacklevel=2)

def get_logger():
'''
Expand Down
34 changes: 34 additions & 0 deletions Lib/test/_test_multiprocessing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4724,6 +4724,40 @@ def test_level(self):
root_logger.setLevel(root_level)
logger.setLevel(level=LOG_LEVEL)

def assert_log_lines(self, expected_values, stream=None):
stream = stream or self.stream
actual_lines = stream.getvalue().splitlines()
self.assertEqual(len(actual_lines), len(expected_values))
for actual, expected in zip(actual_lines, expected_values):
self.assertEqual(actual, expected)
s = stream.read()
if s:
self.fail("Remaining output at end of log stream:\n" + s)

def test_filename(self):
logger = multiprocessing.get_logger()
default_level = logger.level
Copy link
Copy Markdown
Member

@gaogaotiantian gaogaotiantian Dec 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think original_level might be a more proper name for this. It does not have to be the default level.

try:
logger.setLevel(util.DEBUG)
stream = io.StringIO()
handler = logging.StreamHandler(stream)
logging_format = '[%(levelname)s] [%(filename)s] %(message)s'
handler.setFormatter(logging.Formatter(logging_format))
logger.addHandler(handler)
logger.info('1')
util.info('2')
logger.debug('3')
filename = os.path.basename(__file__)
self.assert_log_lines([
Copy link
Copy Markdown
Member

@gaogaotiantian gaogaotiantian Dec 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a utility function might be a bit of an overkill here. Your check is very thorough but it might be too strict. I think something like

output = stream.getvalue()
self.assertIn(f'[INFO] [{filename}] 1', output)
...

should be good enough here. It's clear enough for people about what it's doing, and it's testing against the core issue this PR solves. Making sure the output matches exactly what's expected is not necessarily the best way to do it (especially if it makes the code harder to understand).

f'[INFO] [{filename}] 1',
f'[INFO] [{filename}] 2',
f'[DEBUG] [{filename}] 3',
], stream)
finally:
logger.setLevel(default_level)
logger.removeHandler(handler)
handler.close()


# class _TestLoggingProcessName(BaseTestCase):
#
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2023-12-23-16-10-07.gh-issue-113421.w7vs08.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix multiprocessing logger for ``%(filename)s``.