p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
test_ok2/changelog/7469.deprecation.rst

14 lines
537 B
ReStructuredText
Raw Normal View History

mark: export pytest.Mark for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API.
2020-12-20 04:19:51 +08:00
Directly constructing the following classes is now deprecated:
- ``_pytest.mark.structures.Mark``
mark: export pytest.MarkDecorator for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API.
2020-12-20 21:11:01 +08:00
- ``_pytest.mark.structures.MarkDecorator``
mark: export pytest.MarkGenerator for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API.
2020-12-20 21:36:24 +08:00
- ``_pytest.mark.structures.MarkGenerator``
python: export pytest.Metafunc for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API.
2020-12-27 02:49:17 +08:00
- ``_pytest.python.Metafunc``
runner: export pytest.CallInfo for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API. This also documents `from_call` as public, because at least pytest-forked uses it, so we must treat it as public already anyway.
2020-12-27 03:23:23 +08:00
- ``_pytest.runner.CallInfo``
code: export ExceptionInfo for typing purposes 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.
2021-03-13 17:10:34 +08:00
- ``_pytest._code.ExceptionInfo``
argparsing: export Parser and OptionGroup for typing purposes `Parser` is used by many plugins and custom hooks. `OptionGroup` is exposed by the `parser.addgroup` API. The constructors of both are marked private, they are not meant to be constructed directly.
2021-05-24 04:45:49 +08:00
- ``_pytest.config.argparsing.Parser``
- ``_pytest.config.argparsing.OptionGroup``
Make transitive Pytester types public Export `HookRecorder`, `RecordedHookCall` (originally `ParsedCall`), `RunResult`, `LineMatcher`. These types are reachable through `Pytester` and so should be public themselves for typing and other purposes. The name `ParsedCall` I think is too generic under the `pytest` namespace, so rename it to `RecordedHookCall`. The `HookRecorder`'s constructor is made private -- it should only be constructed by `Pytester`. `LineMatcher` and `RunResult` are exported as is - no private and no rename, since they're being used. All of the classes are made final as they are not designed for subclassing.
2021-10-22 16:34:36 +08:00
- ``_pytest.pytester.HookRecorder``
mark: export pytest.Mark for typing purposes The type cannot be constructed directly, but is exported for use in type annotations, since it is reachable through existing public API.
2020-12-20 04:19:51 +08:00
Make transitive Pytester types public Export `HookRecorder`, `RecordedHookCall` (originally `ParsedCall`), `RunResult`, `LineMatcher`. These types are reachable through `Pytester` and so should be public themselves for typing and other purposes. The name `ParsedCall` I think is too generic under the `pytest` namespace, so rename it to `RecordedHookCall`. The `HookRecorder`'s constructor is made private -- it should only be constructed by `Pytester`. `LineMatcher` and `RunResult` are exported as is - no private and no rename, since they're being used. All of the classes are made final as they are not designed for subclassing.
2021-10-22 16:34:36 +08:00
These constructors have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8.