Bruno Oliveira
bebb6953eb
Merge pull request #8312 from matthewhughes934/add-regendoc-runs-for-fixture-docs
2021-02-04 15:50:48 -03:00
Matthew Hughes
709c211e68
Run regendoc over fixture docs
...
This is the result of running:
$ cd doc/en && make regen REGENDOC_FILES=fixture.rst
2021-02-04 18:32:52 +00:00
Matthew Hughes
97cfd66806
Add regendoc runs for emaillib tests in fixture
...
Also update these tests ensure they pass, and be explicit about the test
file called in an existing test to avoid unintentional calls to the
added tests
2021-02-04 18:32:28 +00:00
Bruno Oliveira
287bab09a4
Merge pull request #8314 from pytest-dev/update-plugin-list/patch-275174e
...
[automated] Update plugin list
2021-02-04 11:54:29 -03:00
Florian Bruhin
b77f071bef
doc: Remove past training
2021-02-04 11:40:28 +01:00
Ran Benita
3907856cb3
Merge pull request #8297 from pytest-dev/monkeypatch-docs
...
doc: Point out two-argument form of monkeypatch.setattr
2021-02-04 10:13:27 +02:00
pytest bot
1d895dd46c
[automated] Update plugin list
2021-02-04 00:26:06 +00:00
Matthew Hughes
298541f540
Add basic emaillib for tests in fixture.rst
...
This will be used to power regendoc runs for later tests
2021-02-03 13:14:31 +00:00
Matthew Hughes
100c8deab5
Fix various typos in fixture docs
2021-02-03 13:14:31 +00:00
pytest bot
3165b1e323
[automated] Update plugin list
2021-02-02 00:31:11 +00:00
bluetech
de06f468ed
[automated] Update plugin list
2021-01-30 00:30:28 +00:00
Florian Bruhin
f0f19aa8d9
doc: Point out two-argument form of monkeypatch.setattr
...
See the "for convenience" part here: https://docs.pytest.org/en/stable/reference.html#pytest.MonkeyPatch.setattr
2021-01-29 21:08:37 +01:00
Maximilian Cosmo Sitter
beda7a8a31
Add plugin list
2021-01-29 16:19:54 +02:00
Bruno Oliveira
7b4ee65bdc
Merge pull request #8284 from encukou/patch-1
...
Doc: Fix typo
2021-01-27 09:40:55 -03:00
Petr Viktorin
56cea26445
Doc: Fix typo
2021-01-27 10:23:18 +01:00
Hong Xu
8bb3977cb6
Doc: Move the module declaration to index.rst
...
When the declaration stays in reference.rst, it creates duplicated
"pytest" symbols such as `pytest.pytest.mark.filterwarnings`.
2021-01-26 00:48:01 -08:00
Christian Steinmeyer
781b73bb52
Mention that class variables are shared between tests
...
Close #8252
2021-01-25 12:02:59 -03:00
Bruno Oliveira
2a890286f8
Merge pull request #8275 from pytest-dev/release-6.2.2
...
Prepare release 6.2.2
(cherry picked from commit 8220eca963
)
2021-01-25 11:53:05 -03:00
Jeff Widman
eef2d1a8e2
Fix pep8 import order in docs ( #8253 )
2021-01-19 11:45:45 -03:00
Ran Benita
25e657bfc1
Deprecate raising unittest.SkipTest to skip tests during collection
...
It is not very clear why this code exists -- we are not running any
unittest or nose code during collection, and really these frameworks
don't have the concept of collection at all, and just raising these
exceptions at e.g. the module level would cause an error. So unless I'm
missing something, I don't think anyone is using this.
Deprecate it so we can eventually clear up this code and keep unittest
more tightly restricted to its plugin.
2021-01-15 00:05:33 +02:00
Gergely Imreh
80c33c8178
Add missing import into example script in documentation
2021-01-08 11:43:51 +00:00
Florian Bruhin
65b8391ead
doc: Add note about training early bird discount
2021-01-05 19:39:50 +01:00
Bruno Oliveira
329fff69a3
Merge pull request #8220 from xuhdev/module-doc
...
DOC: Mark pytest module
2021-01-05 13:25:02 -03:00
Hong Xu
14b5f5e528
DOC: Mark pytest module
...
Pytest document currently does not index the top-level package name
`pytest`, which causes some trouble when building documentation that
cross-refers to the pytest package via ``:mod:`pytest` ``.
2021-01-02 00:34:52 -08:00
Hong Xu
b02f1c8ae7
DOC: Update multiple references to testdir to pytester
...
In https://docs.pytest.org/en/stable/reference.html#testdir , it is
suggested:
> New code should avoid using testdir in favor of pytester.
Multiple spots in the documents still use testdir and they can be quite
confusing (especially the plugin writing guide).
2021-01-01 12:21:39 -08:00
mefmund
5f11a35b99
Add missing fixture ( #8207 )
...
Co-authored-by: Florian Bruhin <me@the-compiler.org>
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-12-31 15:25:44 -03:00
pre-commit-ci[bot]
ee03e31831
[pre-commit.ci] pre-commit autoupdate ( #8201 )
...
* [pre-commit.ci] pre-commit autoupdate
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* manual fixes after configuration update
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Anthony Sottile <asottile@umich.edu>
2020-12-30 11:56:09 +02:00
Ran Benita
96ea867fec
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-26 21:38:37 +02:00
Ran Benita
bd76042344
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-26 21:05:02 +02:00
Ran Benita
5e323becb7
Revert "doc: temporary workaround for pytest-pygments lexing error"
...
Support was added in pytest-pygments 2.2.0.
This reverts commit 0feeddf8ed
.
2020-12-22 21:15:27 +02:00
Ran Benita
6aa4d1c7ab
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 15:59:20 +02:00
Ran Benita
69c302479e
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 15:59:06 +02:00
Ran Benita
2ec372df8b
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 15:58:49 +02:00
Chris NeJame
534d174fd2
Clarify fixture execution order and provide visual aids ( #7381 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
Co-authored-by: Ran Benita <ran@unusedvar.com>
2020-12-16 13:53:14 -03:00
Bruno Oliveira
cab16f3aac
Use transparent PNG for logo ( #8159 )
2020-12-16 11:19:45 -03:00
Bruno Oliveira
56600414df
Merge pull request #8149 from pytest-dev/release-6.2.1
...
Prepare release 6.2.1
(cherry picked from commit a566eb9c70
)
2020-12-15 12:41:02 -03:00
Ran Benita
54a7356a9f
Merge pull request #8130 from pytest-dev/release-6.2.0
...
Prepare release 6.2.0
(cherry picked from commit c475106f12
)
2020-12-12 23:23:19 +02:00
Ran Benita
0feeddf8ed
doc: temporary workaround for pytest-pygments lexing error
...
pytest-pygments doesn't yet recognize the skip reason in summary line
added recently. Workaround it until we get to updating it.
2020-12-12 22:18:23 +02:00
Bruno Oliveira
68a0f22eee
Merge pull request #8100 from nicoddemus/doctest-alternatives
...
List pytest-doctestplus in doctest docs
2020-12-05 17:42:09 -03:00
Ran Benita
e398c93884
Merge pull request #8055 from bluetech/unraisable
...
Add unraisableexception and threadexception plugins
2020-12-05 21:52:17 +02:00
Ran Benita
760a73c08c
Merge pull request #8017 from bluetech/typing-public-fixtures
...
Export types of builtin fixtures for type annotations
2020-12-05 21:51:20 +02:00
Bruno Oliveira
4fc20c8d28
List pytest-doctestplus in doctest docs
...
As per https://github.com/pytest-dev/pytest/discussions/8088
2020-12-04 15:24:56 -03:00
Shubham Adep
d1cb9de211
Custom multiple marker execution order ( #8065 )
...
* Custom multiple marker execution order
https://github.com/pytest-dev/pytest/issues/8020 issue stated that ordering of multiple custom markers is from inside - out. I have added example for the same in the documentation. Please let me know for further changes / concerns.
* remove trailing spaces
The last commit was failing due to extra spaces
* Ran tox tests locally to debug white space trimming issues
* Resolve: ERROR: docs: commands failed for tox -e docs
* Update doc/en/reference.rst
Committed PR suggestions.
Co-authored-by: Florian Bruhin <me@the-compiler.org>
* Added reference to Node.iter_markers_with_node in documentation
* Add myself to Authors
Co-authored-by: Shubham <shubham.adep@wsu.edu>
Co-authored-by: Florian Bruhin <me@the-compiler.org>
2020-11-30 16:48:08 +01:00
Prakhar Gurunani
3405c7e6a8
Add more info about skipping doctests ( #8080 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-11-28 12:47:02 -03:00
Ran Benita
d50df85e26
Add unraisableexception and threadexception plugins
2020-11-21 21:11:48 +02:00
Maximilian Cosmo Sitter
0cef530d10
Add str() support to LineMatcher ( #8050 )
2020-11-21 20:45:20 +02:00
Tim Hoffmann
afd53ede6f
Link mentioned functions instead of using literals ( #8045 )
2020-11-19 15:44:59 +01:00
Florian Bruhin
c6ac618baf
Fix nose documentation
...
Follow-up to #8048 which seems to have been merged without the suggested changes.
2020-11-19 13:54:40 +01:00
mickeypash
ce825ed16c
Add small section on migrating from nose to pytest
...
The section currently features the nose2pytest tool with plans to expand
on some of the common gotchas when performing such migrations.
2020-11-19 08:50:11 -03:00
Ran Benita
f1e6fdcddb
Export types of builtin fixture for type annotations
...
In order to allow users to type annotate fixtures they request, the
types need to be imported from the `pytest` namespace. They are/were
always available to import from the `_pytest` namespace, but that is
not guaranteed to be stable.
These types are only exported for the purpose of typing. Specifically,
the following are *not* public:
- Construction (`__init__`)
- Subclassing
- staticmethods and classmethods
We try to combat them being used anyway by:
- Marking the classes as `@final` when possible (already done).
- Not documenting private stuff in the API Reference.
- Using `_`-prefixed names or marking as `:meta private:` for private
stuff.
- Adding a keyword-only `_ispytest=False` to private constructors,
warning if False, and changing pytest itself to pass True. In the
future it will (hopefully) become a hard error.
Hopefully that will be enough.
2020-11-13 11:25:09 +02:00
Adam Johnson
39b2706f6a
Add 'node_modules' to norecursedirs
...
Fixes #8023 .
2020-11-11 01:52:18 +00:00
Ran Benita
e986d84466
Merge pull request #8006 from bluetech/export-MonkeyPatch
...
Export MonkeyPatch as pytest.MonkeyPatch
2020-11-09 11:45:38 +02:00
Ran Benita
6f13d1b03b
Export MonkeyPatch as pytest.MonkeyPatch
...
We want to export `pytest.MonkeyPatch` for the purpose of
type-annotating the `monkeypatch` fixture. For other fixtures we export
in this way, we also make direct construction of them (e.g.
`MonkeyPatch()`) private. But unlike the others, `MonkeyPatch` is also
widely used directly already, mostly because the `monkeypatch` fixture
only works in `function` scope (issue #363 ), but also in other cases. So
making it private will be annoying and we don't offer a decent
replacement yet.
So, let's just make direct construction public & documented.
2020-11-09 11:28:15 +02:00
Hugo Martins
5b2e5e8a40
Improve summary stats when using '--collect-only' ( #7875 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-11-08 11:45:10 -03:00
frankgerhardt
9bc633064b
Capitalize headlines ( #8008 )
2020-11-07 22:44:04 -03:00
Ran Benita
4c0513bc18
fixtures: deprecate pytest.yield_fixture()
2020-11-07 17:06:40 +02:00
Bruno Oliveira
30287b49cd
Deprecate --strict ( #7985 )
...
Fix #7530
2020-11-06 09:48:20 +01:00
Bruno Oliveira
2753859ff0
Merge pull request #7979 from nicoddemus/metafunc-ref
...
Add FunctionDefinition to the reference docs
2020-10-31 10:00:48 -03:00
Bruno Oliveira
569c091769
Add FunctionDefinition to the reference docs
...
Fix #7968
2020-10-31 08:45:34 -03:00
Bruno Oliveira
0c7233032f
Manually add the remaining 4.6.x release notes to the changelog
...
Fix #7967
2020-10-31 08:36:26 -03:00
Bruno Oliveira
b95991aeea
Merge pull request #7960 from nicoddemus/cherry-pick-release
...
Merge pull request #7958 from pytest-dev/release-6.1.2
2020-10-28 14:36:37 -03:00
Bruno Oliveira
5711ced250
Merge pull request #7958 from pytest-dev/release-6.1.2
...
Prepare release 6.1.2
(cherry picked from commit 1ed903e8fc
)
2020-10-28 14:23:09 -03:00
Gustavo Camargo
b308c6ddb3
Update doctest.rst
2020-10-26 14:30:00 -05:00
Emiel van de Laar
0d9e27a363
doc: Remove unused imports in examples ( #7924 )
...
The "os" imports in the `tmp_path` and `tmpdir` fixture examples are
unused and thus have been removed to prevent confusion.
2020-10-23 17:31:17 +03:00
Matthias Gabriel
e8504e04f3
Fix small typo in reference.rst ( #7922 )
...
Co-authored-by: Ronny Pfannschmidt <opensource@ronnypfannschmidt.de>
2020-10-22 07:11:49 -03:00
Hugo van Kemenade
a642650e17
Drop support for EOL Python 3.5
2020-10-19 10:02:36 +03:00
Bruno Oliveira
0a258f534f
Fix linting
2020-10-17 08:42:15 -03:00
Bruno Oliveira
f58d0a8c3d
Merge pull request #7903 from ekrecker/patch-1
...
Fix typos
2020-10-17 08:41:10 -03:00
Nimesh Vashistha
991bc7bd50
Added note to writing_plugins.rst ( #7896 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-10-17 08:26:30 -03:00
kwgchi
fc70fd23a2
Fix typos
2020-10-16 21:29:58 +09:00
Bruno Oliveira
b4c28dcaa2
Merge pull request #7893 from nicoddemus/testdir-docs-7892
...
List Testdir members in the docs
2020-10-14 10:34:49 -03:00
Prashant Sharma
5182c73fea
Add example for registering multiple custom mark ( #7886 )
2020-10-14 15:17:50 +03:00
Bruno Oliveira
3cae145e41
List Testdir members in the docs
...
Also include docstrings pointing to the counterparts in Pytester.
Fix #7892
2020-10-13 12:01:11 -03:00
Bruno Oliveira
69419cb700
New pytester fixture ( #7854 )
2020-10-12 12:13:06 -03:00
William Jamir Silva
703e89134c
Update reference.rst informing the default junit_family ( #7860 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-10-05 14:04:37 -03:00
Anthony Sottile
f81c6c00a9
Merge pull request #7852 from asottile/py36_pyupgrade
...
py36+: pyupgrade: py36+
2020-10-04 08:25:32 -07:00
Anthony Sottile
66bd44c13a
py36+: pyupgrade: py36+
2020-10-03 12:46:54 -07:00
Ran Benita
fd74dd3dcb
Merge pull request #7849 from pytest-dev/release-6.1.1
...
Prepare release 6.1.1
(cherry picked from commit 69d903260d
)
2020-10-03 22:38:33 +03:00
Ran Benita
7705e5e624
doc: patch Sphinx to detect our `@final` for marking classes as `final`
...
Thanks to Dominic Davis-Foster for code & assistance.
2020-10-03 13:13:14 +03:00
Anthony Sottile
ac189885f6
Merge pull request #7835 from asottile/py36_misc
...
py36+: miscellaneous (3, 6) cleanup
2020-10-02 19:47:35 -07:00
Anthony Sottile
6ba13ed528
Merge pull request #7834 from asottile/py36_TYPE_CHECKING
...
py36+: remove TYPE_CHECKING from _pytest.compat
2020-10-02 19:47:27 -07:00
Anthony Sottile
284fd45a08
py36+: miscellaneous (3, 6) cleanup
2020-10-02 15:04:16 -07:00
Anthony Sottile
a238d1f37d
py36+: remove TYPE_CHECKING from _pytest.compat
...
automated with:
```bash
git grep -l 'from .* import TYPE_CHECKING' |
xargs reorder-python-imports \
--application-directories .:src \
--remove-import 'from _pytest.compat import TYPE_CHECKING' \
--add-import 'from typing import TYPE_CHECKING'
```
2020-10-02 15:03:24 -07:00
Anthony Sottile
3c93eb0f04
py36+: remove pathlib2 compatibility shim
2020-10-02 14:59:07 -07:00
Max Voitko
cb0a13a523
Fix minor typos in doctest.rst ( #7828 )
2020-10-02 15:39:15 +02:00
Ran Benita
f324b27d02
Merge pull request #7748 from nicoddemus/fix-plugin-order-docs
...
Improve docs about plugin discovery/loading at startup
2020-09-27 13:19:58 +03:00
Ran Benita
19c78ab574
Merge pull request #7797 from pytest-dev/release-6.1.0
...
Prepare release 6.1.0
(cherry picked from commit 08a1ab3a8a
)
2020-09-26 21:11:48 +03:00
Kamran Ahmad
d3f47bf346
Improved 'Declaring new hooks' section in docs. ( #7782 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-09-23 11:15:55 -03:00
Bruno Oliveira
7324e90199
Update doc/en/writing_plugins.rst
...
Co-authored-by: Ran Benita <ran@unusedvar.com>
2020-09-19 16:14:28 -03:00
Bruno Oliveira
cdfdb3a25d
Add docs about reusing fixtures from other projects ( #7772 )
...
Co-authored-by: Ran Benita <ran@unusedvar.com>
2020-09-19 16:10:22 -03:00
Bruno Oliveira
98608c439f
Merge pull request #7760 from finn0/docs/punctuation-mark
...
[Docs] remove semi-colon punctuation mark
2020-09-16 12:42:20 -03:00
Faris A Chugthai
9ceb4e6efc
Mistyped was mistyped ( #7762 )
2020-09-16 12:18:03 +02:00
Vipul Kumar
7470270f20
[Docs] remove semi-colon punctuation mark
...
Usually, we use semi-colon punctuation mark to connect closely related
ideas. Sentences which are after semicolon, begins with small letter,
and last sentence always ends with a period mark, see "Garner's Modern
American Usage" book for more information about usage of punctuation
mark. So removing punctuation mark altogether is a good idea, as
@gnikonorov suggested [1].
[1]: https://github.com/pytest-dev/pytest/pull/7760#pullrequestreview-489232607
2020-09-16 06:17:17 +00:00
Faris A Chugthai
cdf2024070
Update writing_plugins.rst ( #7757 )
...
Capitalize the first word in a sentence and add a period at the end.
2020-09-15 16:41:27 +02:00
Bruno Oliveira
4b46db8ae5
Add full command-line flags to the reference docs
...
Fix #7728
2020-09-14 13:42:06 -03:00
Bruno Oliveira
541b30a044
Improve docs about plugin discovery/loading at startup
...
Fix #7691
2020-09-12 14:11:43 -03:00
Ran Benita
e0dd2111a0
Merge pull request #7720 from pytest-dev/release-6.0.2
...
Prepare release 6.0.2
(cherry picked from commit fe69bd5baf
)
2020-09-12 02:05:47 +03:00
Ran Benita
78ed3e48db
Merge pull request #7729 from bluetech/doc-fix-crossrefs
...
doc: fix a few broken cross references
2020-09-11 12:44:29 +03:00
Joseph Lucas
6ae0f741ef
Add example for __test__ ( #7733 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2020-09-09 10:33:39 -03:00
Ran Benita
e503c9a9f8
doc: fix broken cross references
2020-09-06 19:06:43 +03:00