-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
doc: add "Use pytest's strict mode" to good practices #13852
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
Merged
Merged
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 |
|---|---|---|
| @@ -1,10 +1,18 @@ | ||
| Added a :confval:`strict` configuration option to enable all strictness-related options. | ||
|
|
||
| When set to ``True``, the :confval:`strict` option currently enables :confval:`strict_config`, | ||
| :confval:`strict_markers`, :confval:`strict_xfail`, and :confval:`strict_parametrization_ids`. | ||
| When set to ``true``, the :confval:`strict` option currently enables | ||
|
|
||
| * :confval:`strict_config` | ||
| * :confval:`strict_markers` | ||
| * :confval:`strict_parametrization_ids` | ||
| * :confval:`strict_xfail` | ||
|
|
||
| The individual strictness options can be explicitly set to override the global :confval:`strict` setting. | ||
|
|
||
| If new strictness options are added in the future, they will also be automatically enabled by :confval:`strict`. | ||
| Therefore, we only recommend setting ``strict=True`` if you're using a locked version of pytest, | ||
| The previously-deprecated ``--strict`` command-line flag now enables strict mode. | ||
|
|
||
| If pytest adds new strictness options in the future, they will also be enabled in strict mode. | ||
| Therefore, you should only enable strict mode if you use a pinned/locked version of pytest, | ||
| or if you want to proactively adopt new strictness options as they are added. | ||
|
|
||
| See :ref:`strict mode` for more details. |
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.
Should this maybe have a
versionaddeddirective, and/or a quick blurb on how to achieve the same result with older pytest versions?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.
Added the
versionadded. I didn't add how to achieve in previous versions, hopefully can be understood by following the links.