fix: avoid rounding microsecond to `1_000_000` by dqkqd · Pull Request #11861 · pytest-dev/pytest

dqkqd · 2024-01-26T16:05:21Z

I'm using pytest with python 3.9, and my log-date-format is enabled for microseconds. However, my testsuite occasionally fails with the message below:

ValueError: microsecond must be in 0..999999

I'm pretty sure the issue occurred because we're rounding up microsecond here, which make it exceeds 999999.

pytest/src/_pytest/logging.py

Lines 72 to 75 in ac2cd72

    
           # Construct `datetime.datetime` object from `struct_time` 
        
           # and msecs information from `record` 
        
           dt = datetime(*ct[0:6], microsecond=round(record.msecs * 1000), tzinfo=tz) 
        
           return dt.strftime(datefmt)

As we can see msecs can take more than 4 digits after decimal points, hence it can be rounded up to 1_000_000 after multiplying with 1_000. (in python 3.9)

>>> import logging
>>> r = logging.makeLogRecord({'msg': 'Message'})
>>> r.msecs
696.0451602935791

This is "fixed" in python 3.10 and 3.11 python/cpython#89047
They floored msecs so it will always never be rounded to 1_000_000.

>>> import logging
>>> r = logging.makeLogRecord({'msg': 'Message'})
>>> r.msecs
459.0

However, since we also support 3.8 and 3.9, I think we should fix this by flooring microsecond as well.
(I don't know how to write test for this case without mocking time.time())

nicoddemus

Other than my comment, could you please also add a changelog entry? Thanks!

src/_pytest/logging.py

dqkqd · 2024-01-27T12:10:27Z

Thanks for reviewing, I added comment and changelog.

nicoddemus

Thanks, appreciate it!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [pytest](https://docs.pytest.org/en/latest/) ([source](https://github.com/pytest-dev/pytest), [changelog](https://docs.pytest.org/en/stable/changelog.html)) | dev | major | `7.4.4` -> `8.0.0` | --- ### Release Notes <details> <summary>pytest-dev/pytest (pytest)</summary> ### [`v8.0.0`](https://github.com/pytest-dev/pytest/releases/tag/8.0.0): pytest 8.0.0 (2024-01-27) [Compare Source](pytest-dev/pytest@7.4.4...8.0.0) See [8.0.0rc1](https://github.com/pytest-dev/pytest/releases/tag/8.0.0rc1) and [8.0.0rc2](https://github.com/pytest-dev/pytest/releases/tag/8.0.0rc2) for the full changes since pytest 7.4! #### Bug Fixes - [#11842](pytest-dev/pytest#11842): Properly escape the `reason` of a `skip <pytest.mark.skip ref>`{.interpreted-text role="ref"} mark when writing JUnit XML files. - [#11861](pytest-dev/pytest#11861): Avoid microsecond exceeds `1_000_000` when using `log-date-format` with `%f` specifier, which might cause the test suite to crash. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.apud.pl/jacek/adventofcode/pulls/52 Co-authored-by: Renovate <renovate@apud.pl> Co-committed-by: Renovate <renovate@apud.pl>

This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [pytest](https://docs.pytest.org/en/latest/) ([source](https://github.com/pytest-dev/pytest), [changelog](https://docs.pytest.org/en/stable/changelog.html)) | `==7.4.4` -> `==8.0.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/pytest/8.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/pytest/8.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/pytest/7.4.4/8.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pytest/7.4.4/8.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pytest-dev/pytest (pytest)</summary> ### [`v8.0.0`](https://github.com/pytest-dev/pytest/releases/tag/8.0.0): pytest 8.0.0 (2024-01-27) [Compare Source](pytest-dev/pytest@7.4.4...8.0.0) See [8.0.0rc1](https://github.com/pytest-dev/pytest/releases/tag/8.0.0rc1) and [8.0.0rc2](https://github.com/pytest-dev/pytest/releases/tag/8.0.0rc2) for the full changes since pytest 7.4! #### Bug Fixes - [#11842](pytest-dev/pytest#11842): Properly escape the `reason` of a `skip <pytest.mark.skip ref>`{.interpreted-text role="ref"} mark when writing JUnit XML files. - [#11861](pytest-dev/pytest#11861): Avoid microsecond exceeds `1_000_000` when using `log-date-format` with `%f` specifier, which might cause the test suite to crash. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or rename PR to start with "rebase!". 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

nicoddemus requested changes Jan 27, 2024

View reviewed changes

src/_pytest/logging.py Show resolved Hide resolved

dqkqd added 2 commits January 27, 2024 20:41

fix: avoid rounding microsecond to 1_000_000

baf2fa4

docs: add changelog

6d69288

dqkqd requested a review from nicoddemus January 27, 2024 12:10

Update and rename 11861.trivial.rst to 11861.bugfix.rst

0ba9f9f

nicoddemus approved these changes Jan 27, 2024

View reviewed changes

nicoddemus added the needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch label Jan 27, 2024

nicoddemus merged commit a164ed6 into pytest-dev:main Jan 27, 2024

nicoddemus added backport 8.0.x and removed needs backport applied to PRs, indicates that it should be ported to the current bug-fix branch labels Jan 27, 2024

github-actions bot mentioned this pull request Jan 27, 2024

[8.0.x] fix: avoid rounding microsecond to 1_000_000 #11863

Merged

dqkqd deleted the fix-bug-formatter-round-microsecond-to-1000000 branch January 27, 2024 15:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: avoid rounding microsecond to `1_000_000`#11861

fix: avoid rounding microsecond to `1_000_000`#11861
nicoddemus merged 3 commits intopytest-dev:mainfrom
dqkqd:fix-bug-formatter-round-microsecond-to-1000000

dqkqd commented Jan 26, 2024

Uh oh!

nicoddemus left a comment

Uh oh!

Uh oh!

dqkqd commented Jan 27, 2024

Uh oh!

nicoddemus left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	# Construct `datetime.datetime` object from `struct_time`
	# and msecs information from `record`
	dt = datetime(ct[0:6], microsecond=round(record.msecs 1000), tzinfo=tz)
	return dt.strftime(datefmt)

Uh oh!

Conversation

dqkqd commented Jan 26, 2024

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dqkqd commented Jan 27, 2024

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants