ee10ecdf7e
Reorder the reference guides in the docs
...
This changes the order to:
- API Reference
- Fixtures reference
- Configuration
- Exit codes
- Plugin List
which is approximately sorted from general to specific and often used to less used.
Plugin List ist at the end because it points to further external resources.
2022-05-16 23:01:54 +02:00
7b977f4beb
[automated] Update plugin list ( #9959 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-05-16 08:46:51 -03:00
231e220635
Move documentation contents from reference.rst to docstrings
...
It's better to have the documentation in one place, instead
of having some in the docstring and some additional
information added to the reference documentation in
`reference.rst`.
2022-05-10 20:04:25 +02:00
a4a8763ebf
Consistently add **Tutorial**: in front of how-to links in reference
...
Up to now, some had the prefix, some didn't. I think it's good to have
this prefix to give more context, otherwise the links sometimes blend
into the description.
In one case, the link goes to an example, so I used `**Example**:` there.
2022-05-10 16:27:21 +02:00
23c8f3d234
[automated] Update plugin list
2022-05-08 00:18:36 +00:00
306b33e755
[automated] Update plugin list
2022-05-01 00:24:20 +00:00
21091a45d0
[automated] Update plugin list
2022-04-24 00:19:03 +00:00
0347957aa7
Fix wrong `log_file` docs ( #9878 )
...
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2022-04-22 15:15:27 -03:00
6a3168e770
[automated] Update plugin list ( #9864 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-04-20 13:08:36 -03:00
765583dc34
[automated] Update plugin list
2022-04-10 00:17:14 +00:00
79725c9102
[automated] Update plugin list
2022-04-03 00:17:36 +00:00
592fee2263
[automated] Update plugin list
2022-03-27 00:19:03 +00:00
e503faeb6e
[automated] Update plugin list
2022-03-20 00:17:32 +00:00
61f2b265a3
[automated] Update plugin list
2022-03-13 00:15:56 +00:00
bc43d66b47
[automated] Update plugin list ( #9733 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-03-06 00:01:38 -03:00
cf0a4f79b0
[automated] Update plugin list ( #9717 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-03-04 12:56:11 -03:00
0c80a1c836
[automated] Update plugin list ( #9701 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-02-23 08:26:18 -03:00
295e7535c9
[automated] Update plugin list
2022-02-13 00:15:13 +00:00
2c3be75b09
[automated] Update plugin list
2022-02-06 00:13:55 +00:00
321747628e
[automated] Update plugin list
2022-01-30 00:12:51 +00:00
e6166ccc3c
doc/reference: don't document `pytest.__version__` under "Marks"
2022-01-25 22:39:13 +02:00
2907252693
Merge pull request #9528 from SalmonMode/autouse-linearization-graph
2022-01-24 07:47:43 -03:00
dddadefa68
[automated] Update plugin list
2022-01-23 00:12:46 +00:00
1fd0dcd510
fix missing ref to flattened fixture order image
2022-01-19 09:26:07 -05:00
947b5dbc47
[automated] Update plugin list
2022-01-16 00:13:41 +00:00
5c2d752e74
improve docs
2022-01-13 13:29:08 -03:00
0fe0b78a9f
Improve on configuration file docs section
...
To avoid confusions the part of that "the configuration file can
be locate on your tests folder" is removed.
2022-01-13 12:52:18 -03:00
f0dab8ba8d
[automated] Update plugin list
2022-01-09 00:12:59 +00:00
56081ca075
[automated] Update plugin list ( #9468 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2022-01-03 18:57:32 +01:00
55debfad1f
Fix typos ( #9424 )
2021-12-27 09:23:15 -03:00
7a42db2bf0
Merge pull request #9443 from bluetech/undocumented-hooks
...
doc/reference: add 4 missing hooks to reference
2021-12-27 11:11:56 +02:00
427f035b76
[automated] Update plugin list
2021-12-26 00:14:18 +00:00
05d46ca850
doc/reference: add 4 missing hooks to reference
...
Fix #9434 .
2021-12-25 13:54:42 +02:00
a73a9a12a2
[automated] Update plugin list
2021-12-19 00:12:37 +00:00
0e69c62ece
doc: add a `hook` crossref type
...
Allow writing
🪝 `pytest_cmdline_main`
instead of
:func:`pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>`
2021-12-12 16:29:30 +02:00
99a8be200a
[automated] Update plugin list
2021-12-12 00:12:01 +00:00
41d8fb09ca
Remove deprecated `pytest_warning_captured` hook
2021-12-07 22:27:35 +02:00
0ad452bcba
Prepare release version 7.0.0rc1 ( #9375 ) ( #9377 )
...
Co-authored-by: pytest bot <pytestbot@gmail.com>
(cherry picked from commit 85897eddc6d31c5825f5ca28f85e69b8d1506fc4)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2021-12-07 10:13:36 +01:00
72b7334f1d
[automated] Update plugin list
2021-12-05 00:12:43 +00:00
7de752a50b
[automated] Update plugin list
2021-11-28 00:12:22 +00:00
4fd897a631
[automated] Update plugin list ( #9326 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2021-11-21 17:12:22 +02:00
a76df875c7
Remove space inside of dotted attribute
2021-11-10 12:54:21 -08:00
eb6c4493b2
Deprecation of `msg=` for both `pytest.skip()` and `pytest.fail()`. ( #8950 )
...
* porting pytest.skip() to use reason=, adding tests
* avoid adding **kwargs, it breaks other functionality, use optional msg= instead
* deprecation of `pytest.fail(msg=...)`
* fix bug with not capturing the returned reason value
* pass reason= in acceptance async tests instead of msg=
* finalising deprecations of `msg` in `pytest.skip()` and `pytest.fail()`
* Update doc/en/deprecations.rst
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
* Update doc/en/deprecations.rst
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
* fix failing test after upstream merge
* adding deprecation to `pytest.exit(msg=...)`
* add docs for pytest.exit deprecations
* finalising deprecation of msg for pytest.skip, pytest.exit and pytest.fail
* hold a reference to the Scope instance to please mypy
Co-authored-by: Bruno Oliveira <nicoddemus@gmail.com>
2021-11-08 15:31:14 +01:00
2792f9184e
[automated] Update plugin list ( #9274 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2021-11-07 23:12:57 +02:00
49f934618c
Replace hardcoded links to Github issues with extlinks ( #9234 )
2021-11-06 11:16:11 +02:00
b0aa870b11
Export CollectReport and TestReport
...
Refs #7469 .
2021-11-02 20:58:51 +02:00
a53abe93d8
Merge pull request #9208 from bluetech/legacypath-plugin
...
Add legacypath plugin, move py.path stuff there
2021-11-02 20:35:12 +02:00
81e2d46302
[automated] Update plugin list
2021-10-31 00:11:03 +00:00
e6eac28f0e
legacypath: only add `testdir` and `tmpdir` fixtures if corresponding plugins are registered
...
This preserves the existing behavior and gives a proper error message
in case e.g. `testdir` is requested without the `pytester` plugin being
loaded.
2021-10-29 13:11:12 +03:00
5e883f5195
Move tmpdir to legacypath plugin
2021-10-28 21:51:51 +03:00
bcad6e8e9a
Make plugin list in PDF docs readable ( #9241 )
...
The current PDF docs attempt to format the list of all plugins as a
table, without any word-wrapping of the plugin description. That results
in almost all the information getting cut off. This PR formats the same
information into more of a paragraph format for the PDF, with nothing
cut off.
Fixes #451
2021-10-28 11:31:52 +03:00
3c5c5feb04
Merge pull request #9230 from bluetech/pytester-transitive-public
...
Export pytester transitive types
2021-10-27 08:05:08 +03:00
2f0e1cd230
[automated] Update plugin list
2021-10-24 00:11:06 +00:00
11e36c8493
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-23 10:59:18 +03:00
1e9e16d829
Replace hardcoded links to PyPI with extlinks ( #9224 )
2021-10-22 09:47:57 -03:00
4a3834101e
Merge pull request #9209 from pytest-dev/update-plugin-list/patch-0696d3eda
...
[automated] Update plugin list
2021-10-19 06:53:25 -03:00
20a69e11aa
Merge pull request #9214 from nicoddemus/confcutdir-9210
2021-10-19 06:52:52 -03:00
c000955dde
Remove incorrect docs about confcutdir being a config option
...
Fix #9210
2021-10-18 19:20:27 -03:00
3cc0c451e7
[automated] Update plugin list
2021-10-17 00:11:56 +00:00
4b417ac38e
[automated] Update plugin list ( #9186 )
...
Co-authored-by: pytest bot <pytestbot@users.noreply.github.com>
2021-10-10 12:00:43 -03:00
fb52fc5163
Merge pull request #9070 from andrewdotn/main
2021-10-05 16:51:58 -03:00
c82bda259c
Add a `pythonpath` setting to allow paths to be added to `sys.path`. ( #9134 )
2021-10-05 09:36:38 +03:00
028eb6fab6
Merge pull request #9115 from RonnyPfannschmidt/fix-regendoc
...
fix #8818 - run regendoc without tox cachedir
2021-10-04 19:11:45 +02:00
c21ef7ba22
fix #8818 - run regendoc without tox cachedir
...
#4270 introduced per tox env pytest cachedirs and
never protected regendoc against it
2021-10-04 08:56:26 +02:00
618ee0f268
[automated] Update plugin list
2021-10-03 00:11:19 +00:00
4a016db7b4
[automated] Update plugin list
2021-09-26 00:11:24 +00:00
4ae4bec968
scripts/update-plugin-list: escape summary for special RST chars
...
A new plugin has this summary:
Continiously runs pytest on changes in *.py files
The `*` is interpreted as a special character and fails the CI.
Add some rudimentary escaping to hopefully prevent this.
2021-09-22 16:39:15 +03:00
86fc02bfcb
[automated] Update plugin list
2021-09-19 00:10:14 +00:00
0407c62121
[automated] Update plugin list
2021-09-12 00:11:27 +00:00
8900e3b937
Merge pull request #9041 from hoefling/doc/stdlib-crossrefs
2021-09-07 21:22:24 +10:00
1f00461e57
[automated] Update plugin list
2021-09-05 00:09:51 +00:00
e929d15848
Include figures in PDF docs
...
The PDF documentation on readthedocs was missing the figures in the
fixtures reference chapter. This PR uses a Sphinx plugin that
automatically converts the checked-in SVG files to the PDF input files
that LaTeX requires.
The SVG-to-PDF conversion is done by inkscape, which gave the best
conversion among the tools I tried. However, it [does not yet
understand][href-bug] that you can write a plain `href` instead of
`xlink:href` in svg files, so I’ve had to edit the SVG files
accordingly.
[href-bug]: https://github.com/TeX-Live/luatex.git
2021-09-02 17:40:41 -06:00
544ecce677
[automated] Update plugin list
2021-08-29 00:09:53 +00:00
d1aea7d7a8
use intersphinx crossrefs to stdlib docs where possible instead of hardcoded URLs
...
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-08-26 16:05:03 +02:00
109bc2649d
Adapt docs references to use pluggy 1.0
...
Also use the intersphinx reference instead of the class directly.
2021-08-26 09:52:05 -03:00
696bf96c83
Fix typo in fixture.rst
2021-08-24 09:32:40 -03:00
1b130d4404
[automated] Update plugin list
2021-08-22 00:09:13 +00:00
0f79fc6dbb
Merge pull request #8752 from azmeuk/issue-7132-syntax-highlight-themes
2021-08-15 09:06:41 -03:00
1cbb67f71b
[automated] Update plugin list
2021-08-15 00:09:52 +00:00
7770dacb8d
pygments themes are customizable
2021-08-13 19:15:01 +02:00
4d2944e1d4
[automated] Update plugin list
2021-08-08 00:10:10 +00:00
fed18fb76d
[automated] Update plugin list
2021-08-01 00:10:10 +00:00
6247a95601
Merge pull request #8920 from bluetech/stabilize-store
...
Rename Store to Stash and make it public
2021-07-31 10:32:30 +03:00
8b5b3575a0
[automated] Update plugin list
2021-07-25 00:08:36 +00:00
c6bdeb8491
stash: make Stash and StashKey public
...
It's had enough time to bake - let's allow external plugins to use it.
2021-07-24 17:40:08 +03:00
0a1f58a912
[automated] Update plugin list
2021-07-18 00:08:39 +00:00
388691a205
rename tmpdir.rst to tmp_path.rst ( #8905 )
2021-07-14 12:53:27 -03:00
828fde1156
Merge pull request #8858 from The-Compiler/update-doc-urls
2021-07-14 09:28:46 -03:00
b6648219ec
[automated] Update plugin list
2021-07-11 00:08:26 +00:00
953fdabaf0
Adjust doc links for new scheme
...
Closes #8831
2021-07-06 09:11:35 +02:00
f0e5640497
[automated] Update plugin list
2021-06-27 00:08:04 +00:00
7eb0792cba
Add pytest.version_tuple
...
This adds `pytest.version_tuple`, which makes it simpler for users to do something depending on the pytest version, such as declaring hooks which are introduced in later versions.
This feature was added originally in https://github.com/pypa/setuptools_scm/pull/475 .
Followup to https://github.com/pytest-dev/pytest/pull/7605 .
2021-06-14 09:04:14 -03:00
5ea541d415
[automated] Update plugin list
2021-06-13 00:10:04 +00:00
fb7e36b2f7
Merge pull request #8735 from pytest-dev/update-plugin-list/patch-8300b266a
...
[automated] Update plugin list
2021-06-12 10:49:02 -03:00
479209bde1
Fix typo in fixture.rst
...
Example referenced the wrong function name
2021-06-09 15:13:48 -07:00
50b166ff0b
[automated] Update plugin list
2021-06-06 00:17:08 +00:00
360ce686f1
Merge pull request #8713 from pytest-dev/update-plugin-list/patch-43faea832
...
[automated] Update plugin list
2021-05-31 10:54:38 -03:00
cf7425d22b
Fix a typo in documentation about tmpdir_factory
...
The section refers to tmpdir_factory, but the sentence mentionned
tmp_path_factory.
2021-05-31 09:36:18 +02:00
4b7d8b2edd
[automated] Update plugin list
2021-05-30 00:23:19 +00:00
1ba5b48565
Merge pull request #8697 from bluetech/expose-config
...
config: expose Config and PytestPluginManager for typing purposes
2021-05-26 11:20:42 +03:00
1b5f5326d7
Merge pull request #8695 from bluetech/export-parser
...
argparsing: export Parser and OptionGroup for typing purposes
2021-05-26 11:20:03 +03:00
c0d525e44c
config: expose PytestPluginManager for typing purposes
...
This type is used in hooks and transitively through `Config`.
2021-05-24 12:27:07 +03:00
88d84a5791
config: expose Config for typing purposes
...
This type is used in hooks and fixtures.
The constructor is publicly documented so is not marked private.
2021-05-24 12:26:22 +03:00
538b5c2499
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 00:52:03 +03:00
11538e35e4
[automated] Update plugin list
2021-05-23 00:12:33 +00:00
a69ed66c2e
[automated] Update plugin list
2021-05-16 00:10:52 +00:00
e0a3dc7bf8
[automated] Update plugin list
2021-05-09 00:05:23 +00:00
8f49ffdb57
[automated] Update plugin list
2021-05-02 00:12:49 +00:00
788d445b7b
[automated] Update plugin list
2021-04-25 00:20:16 +00:00
c117bc350e
[automated] Update plugin list
2021-04-18 00:18:53 +00:00
9078c3ce23
fix #8464 wrong root dir when -c is passed ( #8537 )
...
fix #8464 wrong root dir when -c is passed
2021-04-16 14:38:35 -03:00
8dd64622ca
Merge pull request #8538 from pytest-dev/update-plugin-list/patch-9653a0e
...
[automated] Update plugin list
2021-04-14 12:52:29 +03:00
4b214a6049
Add tmp_path_factory methods to the docs ( #8550 )
...
* Add tmp_path_factory methods to the docs
Add the methods of tmp_path_factory to the docs.
Currently, only the class description appears in the docs.
* Add tmpdir_factory methods to the docs
2021-04-14 12:06:35 +03:00
67d61e56e9
[automated] Update plugin list
2021-04-11 00:20:34 +00:00
70daa279a7
Further rationalised "how to invoke pytest" material. ( #8536 )
...
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2021-04-08 21:19:30 -03:00
f3337c1854
[automated] Update plugin list
2021-04-04 00:19:23 +00:00
b96e229c95
Fix plugin-list label in the docs ( #8505 )
...
Last time I "fixed" this I left a `\` at the start of the string
to avoid an initial newline, but didn't realize it was a raw string.
This should fix it now for good.
2021-04-01 15:12:46 +02:00
bfdfab00dd
[automated] Update plugin list
2021-03-28 00:18:38 +00:00
c1e057065c
Fix plugin-list label and script
...
This was changed during the current docs restructing and
we missed that it changed the label.
2021-03-26 07:13:52 -03:00
3add1a4d0f
[automated] Update plugin list
2021-03-21 00:50:28 +00:00
fe215bda6b
Merge pull request #8446 from bluetech/unnecessary-py-path-2
...
More py.path removal work
2021-03-18 10:20:59 +02:00
6ab461f460
Explicitly listed the four documentation sections on index.rst
2021-03-16 20:26:05 +00:00
a03ee02817
config: make `collect_ignore` accept any PathLike
...
The main reason is to remove a reference to `py.path`.
2021-03-15 10:39:32 +02:00
2641761c1c
Merge pull request #8441 from evildmp/evolutionary-documentation-restructure
...
Moved more sections from reference to how-to.
2021-03-15 10:22:11 +02:00
59251e8a2a
Remove/replace some unneeded usages of py.path
2021-03-14 14:12:28 +02:00
ba7bd3d77c
doc/tmpdir: significantly reduce space dedicated to tmpdir/tmpdir_factory
...
Emphasize tmp_path/tmp_path_factory and just note the legacy ones.
2021-03-13 20:44:23 +02:00
db539ed2b0
Merge pull request #8437 from bluetech/rm-typevar-prefix
...
Remove `_` prefix from TypeVars, expose ExceptionInfo
2021-03-13 19:01:29 +02:00
f2d65c85f4
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 15:59:44 +02:00
8410d9ac54
Created a new Explanation section and new landing pages for main sections.
...
Added landing pages for:
How-to guides
Reference guides
Explanation
Added links to the main landing pages to the sidebar.
2021-03-12 22:57:53 +00:00
ff2ee96b8c
Split fixtures documentation into separate documents.
...
Sections have been moved to:
* reference/fixtures.rst
* how-to/fixtures.rst
* fixtures.rst
according to their function. Further refinement and rewriting will be required.
Some material has been moved to a new "Anatomy of a test" document, in
anticipation that material from other sections will also find a natural
home there later.
Removed several unneeded reference targets from fixtures documentation.
2021-03-12 22:16:47 +00:00
d8695410a4
Added how-to and reference directories.
...
Moved various documents into subdirectories, how-to and
reference.
Updated multiple links to use `:ref:` instead of `:doc:`,
meaning that files can henceforth be moved around without
breaking references.
2021-03-11 22:13:01 +00:00
Tim Hoffmann
github-actions[bot]
pytest bot
Zac Hatfield-Dodds
Ran Benita
Bruno Oliveira
Chris NeJame
Emmanuel Arias
Kian Meng, Ang
Florian Bruhin
Eddie
Simon K
Oleg Höfling
andrewdotn
Brian Okken
Ronny Pfannschmidt
oleg.hoefling
William Jamir Silva
Éloi Rivard
Thomas Grainger
Jason Haugen
Denis Laxalde
Abdelrahman Elbehery
Albert Villanova del Moral
Daniele Procida