Remove _ prefix from TypeVars, expose ExceptionInfo
#8437
Merged
Conversation
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
The prefixes make the API Reference docs (for e.g. `pytest.raises`, `pytest.fixture`) uglier. Being under `_pytest` is sufficient from a privacy perspective, so let's drop them.
No such thing as `_pytest._code.AssertionError`, it's just the built-in `AssertionError`.
This type is most prominent in `pytest.raises` and we should allow to refer to it by a public name. The type is not in a perfectly "exposable" state. In particular: - The `traceback` property with type `Traceback` which is derived from the `py.code` API and exposes a bunch more types transitively. This stuff is *not* exported and probably won't be. - The `getrepr` method which probably should be private. But they're already used in the wild so no point in just hiding them now. The __init__ API is hidden -- the public API for this are the `from_*` classmethods.
bluetech
force-pushed
the
rm-typevar-prefix
branch
from
610c625 to
f2d65c8
Compare
nicoddemus
approved these changes
Mar 13, 2021
Member
|
If worst comes to worse, let's just assign the classes module as pytest |
Member
Author
Do you mean like |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is some work per comment #8405 (comment).
The first commit removes the
_from the TypeVars.The third commit exposes
ExceptionInfo(cc #7469). I still need to figure out how to get sphinx to use the public names but ran out of time for today (I also opened some sphinx issues).