-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Allow int for truncation_limit_lines and truncation_limit_chars in TOML
#14692
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.
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
Pierre-Sassoulas
wants to merge
2
commits into
pytest-dev:main
Choose a base branch
from
Pierre-Sassoulas:fix-truncation-limit-int-14675
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| The :confval:`truncation_limit_lines` and :confval:`truncation_limit_chars` configuration options now accept integer values in TOML configuration files, while still accepting strings for backward compatibility. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,14 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from dataclasses import dataclass | ||
| from typing import ClassVar | ||
| from typing import Literal | ||
| from typing import Protocol | ||
| from typing import TYPE_CHECKING | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from _pytest.config import Config | ||
|
|
||
|
|
||
| _AssertionTextDiffStyle = Literal["ndiff", "block"] | ||
|
|
@@ -17,8 +23,29 @@ class TruncationBudget: | |
| dimension; ``0`` leaves it unbounded (the limit is disabled). | ||
| """ | ||
|
|
||
| max_lines: int | ||
| max_chars: int | ||
| #: Default limits applied when the corresponding ini option is left unset. | ||
| DEFAULT_MAX_LINES: ClassVar[int] = 8 | ||
| DEFAULT_MAX_CHARS: ClassVar[int] = DEFAULT_MAX_LINES * 80 | ||
|
|
||
| max_lines: int = DEFAULT_MAX_LINES | ||
| max_chars: int = DEFAULT_MAX_CHARS | ||
|
|
||
| @classmethod | ||
| def from_config(cls, config: Config) -> TruncationBudget: | ||
| """Build a budget from the ``truncation_limit_*`` ini options. | ||
|
|
||
| Both options are registered with ``type=int | str`` for | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this comment belongs on the |
||
| backward compatibility, so :meth:`~_pytest.config.Config.getini` may | ||
| return an ``int`` (native TOML value) or a ``str`` (INI files, ``-o`` | ||
| overrides); it returns ``None`` when the option is unset, which falls | ||
| back to the default limit. | ||
| """ | ||
| max_lines = config.getini("truncation_limit_lines") | ||
| max_chars = config.getini("truncation_limit_chars") | ||
| return cls( | ||
| max_lines=cls.DEFAULT_MAX_LINES if max_lines is None else int(max_lines), | ||
| max_chars=cls.DEFAULT_MAX_CHARS if max_chars is None else int(max_chars), | ||
| ) | ||
|
|
||
|
|
||
| # Reusable "no cap" budget, used as a default argument (B008). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this introduces a cyclic dependency, maybe the previous location is better.