Commit Graph

867 Commits

Author SHA1 Message Date
mbyt 77d842ceb2 better doc for #1890 based on #1932 2016-09-17 19:58:27 +02:00
Skylar Downes 34117be98b Update goodpractices.rst 2016-09-15 16:45:35 -07:00
Skylar Downes 330a2f6784 Update getting-started.rst 2016-09-15 16:28:37 -07:00
Skylar Downes 81a733f2dc add how-to for getting started on existing project
ref #1937
2016-09-15 15:09:47 -07:00
Skylar Downes 07ad71e851 clarified purpose of `pip install -e` command
ref #1937
2016-09-15 14:55:54 -07:00
Skylar Downes b4fd74c6ff add mention of setup.py develop 2016-09-15 14:10:57 -07:00
Skylar Downes 69f72c6f4b fix typo 2016-09-15 10:49:59 -07:00
Skylar Downes 383fc02ba6 fix spacing 2016-09-15 10:47:16 -07:00
Skylar Downes d217984129 documenting how to point pytest at local code
Related to #1937
2016-09-15 10:46:15 -07:00
Bruno Oliveira 138e255631 Remove duplicated for Metafunc members on docs
Fix #1924
2016-09-14 17:11:58 -03:00
Florian Bruhin 8e67dd13e7 Fix link to PDF docs
Fixes #1917
2016-09-06 21:17:54 +02:00
Ronny Pfannschmidt a2b8981b50 docs: remove unused helper script 2016-09-05 21:03:22 +02:00
Ronny Pfannschmidt e21ae3991d docs: remove the need for special scripts
* import version from pytest since it is importable
* remove makefile bits from legacy hosting
* remove the script to determine the version for legacy hosting
2016-09-05 16:42:33 +02:00
Bruno Oliveira 183f3737d4 Fix reference docs for monkeypatch
Fix #1909
2016-09-03 15:47:54 -03:00
Bruno Oliveira 927f411ee2 Fix release 3.0.2 release announcement list of authors 2016-09-01 21:28:30 -03:00
Bruno Oliveira a9f3053f72 Fix version typo in announce for 3.0.2 2016-09-01 06:59:31 -04:00
Bruno Oliveira d512e7f26b Run regendoc for 3.0.2 release 2016-08-31 20:32:05 -04:00
Bruno Oliveira f985f47a02 Fix reportingdemo call to pytest 2016-08-31 20:30:06 -04:00
Bruno Oliveira 4c45b93007 Changes for 3.0.2 release 2016-08-31 20:28:38 -04:00
mbyt e43d1174f7 spelling 2016-08-31 22:46:40 +02:00
mbyt 696a9112be integrating review commets of @nicoddemus
plus small scale refactoring
2016-08-31 22:33:47 +02:00
Bruno Oliveira 519f02b014 docs warnings as errors and initial page similar to README
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829
2016-08-26 17:47:18 -03:00
Bruno Oliveira e92d373460 Remove example of "monkeypatch" used in session scope
This is a leftover when invocation-scoped fixtures
were pulled back.

Fix #1872
2016-08-25 21:50:57 -03:00
Bruno Oliveira 49fc4e5e4c Changes for 3.0.1 release 2016-08-23 18:15:43 -04:00
Adam Chainz 1673667232 Delete unreferenced setup.cfg from docs
Noticed it's not using the new `[tool:pytest]` header as changed in #567, can't find any reference to it or `testfilepatterns`. It was added in b1e4301457 6 years ago, there don't seem to have ever been references to it.
2016-08-23 16:08:24 +01:00
Dmitry Dygalo 3fbf2e7a80 Fix documentation 2016-08-22 18:38:02 +02:00
Daniel Hahler e306a53999 Fix spelling: s/outside a/outside of a/ 2016-08-20 18:43:39 +02:00
Bruno Oliveira 9aec8d9a47 py.test team -> Pytest team :) 2016-08-19 18:59:13 -03:00
Bruno Oliveira c8f53d6690 Fix typo in 3.0.0 release announcement 2016-08-19 18:58:14 -03:00
Bruno Oliveira 875bcd4224 Add 3.0.0 release announcement to index.rst 2016-08-19 18:30:11 -03:00
Bruno Oliveira 745c8c17f1 Merge remote-tracking branch 'upstream/master' 2016-08-19 17:38:21 -03:00
matthiasha c8fbf3ae34 remove dot in pytest 2016-08-19 14:02:25 +02:00
matthiasha 799dab9dba Documentation update for rootdir discovery
This covers issue https://github.com/pytest-dev/pytest/issues/1435.
2016-08-19 09:01:12 +02:00
Bruno Oliveira c74ce371ab Add release announcement 2016-08-18 12:02:01 -04:00
Bruno Oliveira 9ce30e0085 Run regendoc for 3.0 release 2016-08-18 08:27:16 -04:00
Florian Bruhin 789e4670e7 Merge pull request #1813 from nicoddemus/pytest-setup.cfg
Support [tool:pytest] in setup.cfg files
2016-08-17 20:33:57 +02:00
Florian Bruhin c8ab79402c Merge pull request #1811 from nicoddemus/revert-invocation-fixtures
Revert invocation-fixtures code
2016-08-17 20:32:54 +02:00
Bruno Oliveira ab86dea529 Support [tool:pytest] in setup.cfg files
Also deprecate [pytest] usage in setup.cfg files

Fix #567
2016-08-17 08:19:38 -03:00
Bruno Oliveira 707b6b5e3f Revert all invocation-fixtures code
Due to a serious regression found in #1794, it was decided to pull off
invocation features from 3.0 so it can be (hopefully) re-introduced
in 3.1
2016-08-17 08:12:55 -03:00
Bruno Oliveira f25771a101 Deprecate --resultlog cmdline option
Fix #830
2016-08-16 21:40:34 -03:00
Floris Bruynooghe 99a4a1a784 Merge pull request #1791 from nicoddemus/ide-integration-1790
Internal adjustments for easier integration with IDEs
2016-08-07 23:50:50 +01:00
Bruno Oliveira 802755ceed Merge remote-tracking branch 'upstream/master' into merge-master-into-features 2016-08-06 17:58:17 -03:00
Dave Hunt eb08135280 Update documentation to describe expected rootdir behaviour 2016-08-06 19:35:40 +02:00
Bruno Oliveira 08002ab75a Add longreprtext property to TestReport objects
Related to #1790
2016-08-03 21:49:28 -03:00
Bruno Oliveira 8b8c698f1a Add more interpreter versions to multipython example 2016-08-03 16:48:49 -04:00
Bruno Oliveira d28801d794 Make parametrize example deterministic 2016-08-03 16:48:11 -04:00
Bruno Oliveira 72df32f1fd Fix missing print() 2016-08-03 17:34:55 -03:00
Bruno Oliveira 701d5fc727 Regendoc after more fixes on features branch 2016-08-03 16:31:44 -04:00
Bruno Oliveira 21a90c8c50 Run regendoc again 2016-08-01 20:12:00 -04:00
Bruno Oliveira eed21e06db Sort yml items to get same results for regendoc runs 2016-08-01 20:09:35 -04:00
Bruno Oliveira a6b2732507 Pass list of params to pytest.main() in docs 2016-08-01 20:09:35 -04:00
Bruno Oliveira 946466abf4 Run regen-docs for pytest 3.0 2016-08-01 20:09:35 -04:00
Florian Bruhin ffb583ae91 Merge pull request #1773 from nicoddemus/fix-freeze
Use PyInstaller for freeze test env
2016-07-27 15:06:54 +02:00
Bruno Oliveira ae9d3bf886 Freeze docs: PyInstaller hook and wording
As discussed during the review, suggest in general
to use PyInstaller and just mention pytest.freeze_includes()
in less detail on how to actually use it, because it varies
from tool to tool.
2016-07-27 09:15:40 -03:00
Bruno Oliveira ed36d627e4 Use PyInstaller for freeze test env
cx_freeze doesn't seem to be very well supported in Python 3.5.

Using pyinstaller instead and rename environment to "freeze" which
is a more generic term for freezing python code into standalone
executables.

Fix #1769
2016-07-26 22:02:37 -03:00
Bruno Oliveira 0b8a91b858 Fix pdf links in the documentation
Fix #1436
2016-07-26 20:20:22 -03:00
Bruno Oliveira c2864aba3d Merge branch 'master' into merge-master
# Conflicts:
#	AUTHORS
#	CHANGELOG.rst
#	_pytest/monkeypatch.py
#	_pytest/python.py
2016-07-25 19:06:29 -03:00
Roberto Polli ab6aef1d1f feature: default behavior now is to ignore duplicate paths specified from the command line. Use --keep-duplicates to retain duplicate paths. 2016-07-25 12:41:58 +02:00
Romain Dorgueil f8f690de64 adds the versionadded flag in docs (#1749) 2016-07-23 15:30:06 +02:00
Romain Dorgueil fd8e019cc1 Choose the doctest output format in case of failure, still work in progress as a few checks fail (related to #1749) 2016-07-23 14:40:46 +02:00
Bruno Oliveira 05f3422d7c Make monkeypatch invocation-scoped 2016-07-20 22:05:49 -03:00
Bruno Oliveira 4f2bf965cb Merge remote-tracking branch 'upstream/features' into invocation-scoped-fixtures 2016-07-20 21:16:27 -03:00
Bruno Oliveira 20f97c3041 Small documentation improvements 2016-07-20 20:22:28 -03:00
Oliver Bestwalter 58a8150bc5 add backwards compatibility policy 2016-07-17 21:14:16 +02:00
Floris Bruynooghe 0a53797fa3 Document the re-writing of plugins 2016-07-17 12:30:21 +01:00
Bruno Oliveira ff8fb4950e setup_* and teardown_* functions argument now optional
setup_module, setup_function and setup_method
extra argument are now optional and may be omitted.

Fix #1728
2016-07-14 23:41:40 -03:00
Bruno Oliveira 9007e16cdf Document limitations for yield-tests in nose
Also add nose doc to the root toctree

Closes #1716
2016-07-14 08:20:01 -03:00
Bruno Oliveira f827810fa8 Fix 2.10 -> 3.0 versions in docs 2016-07-12 21:02:40 -03:00
Bruno Oliveira 29289b472f Add documentation for "invocation" scoped fixture 2016-07-09 16:51:25 -03:00
Ronny Pfannschmidt b9a91dc112 merge from master to features 2016-07-06 11:51:48 +02:00
Bruno Oliveira 8d39ce17da Fix links and removed 404 links from talks.rst
Fix #1696
2016-07-04 21:32:57 -03:00
Brandon W Maister 771c4539fa Document the interaction of autouse scopes
I wouldn't have even attempted what I did to cause #1688 if this had
been there.
2016-06-29 16:52:13 -04:00
Ronny Pfannschmidt 2a43237527 docs: no longer include python 3.0-3.2 in the index page 2016-06-27 18:20:56 +02:00
Eli Boyarski 21d27784eb catched -> caught
Even though catch is a Python keyword, 'catched' just looks terrible in text.
If the text was supposed to reference the keyword, then 'catched' should be changed to "'catch'ed".
2016-06-27 15:41:40 +03:00
RedBeardCode 0e2ebc96ff Remove deprecated cmd options
Fixes #1657
2016-06-26 19:26:04 +02:00
holger krekel 13a188fe37 Merge pull request #1647 from sallner/features
Add new options to report fixture setup and teardown
2016-06-25 16:38:37 +02:00
Raphael Pierzina eb98a8eefb Change version in issues section to pytest 3.0 only 2016-06-25 14:52:57 +02:00
Raphael Pierzina acfdd85dff Move document to proposals subfolder 2016-06-25 14:42:19 +02:00
Danielle Jenkins 7a3daac85b Add docs for setuponly and setupplan options. 2016-06-25 12:21:12 +02:00
Raphael Pierzina 5860c609ae Remove note on scoping 2016-06-25 11:09:46 +02:00
Raphael Pierzina 526c564576 Fix rst bullet point lists 2016-06-25 11:06:17 +02:00
Raphael Pierzina 693859210a Add yielded values to function example 2016-06-25 11:00:54 +02:00
Raphael Pierzina 4f8b8c8d31 Add alternative approach that uses wrappers 2016-06-25 10:55:08 +02:00
Raphael Pierzina c6a711c2fc Add proposed solution using a module function 2016-06-25 10:50:14 +02:00
Raphael Pierzina 84f0dcecf8 Add issues section to proposal doc 2016-06-25 10:10:57 +02:00
Brianna Laugher 7612b650a0 update sprint page to be past tense 2016-06-24 17:24:06 +02:00
Brianna Laugher 62255d8000 rm global header 2016-06-24 17:12:41 +02:00
Brianna Laugher ea5bda0898 remove links to funding campaign 2016-06-24 17:11:29 +02:00
Raphael Pierzina dc55551213 Start proposal for parametrize with fixtures 2016-06-24 12:08:57 +02:00
Tom Viner df9918eda3 issue1625, name getfuncargvalue to getfixturevalue 2016-06-24 10:08:19 +02:00
Ronny Pfannschmidt 18ef7de96b merge from master again 2016-06-22 16:03:52 +02:00
HEAD KANGAROO be1dabd6a9 cache.rst: Fix wrong command used
The "Inspecting Cache content" section was showing --cache-clear command,
  but should actually be using --cache-show command.

  Also; update AUTHORS
2016-06-22 14:04:02 +01:00
Ronny Pfannschmidt 083f64100d merge master into features 2016-06-22 14:39:33 +02:00
Dave Hunt ef9dd14963 Introduce pytest command as recommended entry point
Fixes #1629
2016-06-21 16:16:57 +02:00
Florian Bruhin 4f2db6c08d Merge pull request #1616 from palaviv/pytest.raises-message
Pytest.raises custom error message
2016-06-20 18:43:12 +02:00
palaviv f8d4cadc3d Added versionchanged directives 2016-06-19 23:56:43 +03:00
palaviv c29130d400 Updated documentation 2016-06-19 23:34:42 +03:00
Bruno Oliveira 72bf11cbe9 Add disabled() method to capsys and capfd
Fix #1599
2016-06-19 19:14:36 +02:00
Bruno Oliveira ed69424917 Remove most content from yieldfixture as it is now deprecated 2016-06-08 21:07:55 -03:00
Bruno Oliveira fe4f23c1bf Update docs in prol of using yield statements 2016-06-08 21:07:52 -03:00
Marius Gedminas 3ad5b9de86 Docs: config.option is deprecated
https://pytest.org/latest/writing_plugins.html#_pytest.config.Config says config.option is deprecated and one should use config.getoption() instead.
2016-06-02 09:52:56 +03:00
Ronny Pfannschmidt 7305adfdba fix another copy&paste error in the announcement list 2016-06-01 08:55:44 +02:00
Ronny Pfannschmidt b5bd4d959d merge master to features 2016-06-01 08:13:26 +02:00
Ronny Pfannschmidt 5c8b0fb523 fix minor typos 2016-06-01 08:03:22 +02:00
Ronny Pfannschmidt 978bb190a1 add release announcement 2016-05-31 19:06:29 +02:00
Ronny Pfannschmidt 77c28825df regendoc and comment out a python2.7 example as per #1573 2016-05-31 19:05:36 +02:00
Bruno Oliveira 28efdebfcd Remove "experimental" status from hookwrapper 2016-05-31 12:17:55 -03:00
Bruno Oliveira 8c1be624a6 Merge pull request #1554 from RonnyPfannschmidt/merge-master
Merge master into features
2016-05-24 11:09:33 -03:00
Bruno Oliveira 5ab5a11544 Merge pull request #1565 from tomviner/issue1544/ignore-build-dist-dirs
Issue 1544: norecursedirs build & dist dirs
2016-05-23 19:30:20 -03:00
Ronny Pfannschmidt 26b526967e merge from master again 2016-05-23 22:33:00 +02:00
TomV d6dfb1a393 issue 1544: norecursedirs build & dist dirs 2016-05-23 21:02:29 +01:00
Adam Chainz 8a39869347 Convert readthedocs link for their .org -> .io migration for hosted projects
As per their email ‘Changes to project subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified. One was not modified - `http://media.readthedocs.org/epub/pytest/latest/pytest.epub` - since it doesn't work on `readthedocs.io`.
2016-05-18 17:12:39 +01:00
Ronny Pfannschmidt eab762ea99 Merge branch 'master' into merge-master 2016-05-13 19:37:41 +02:00
Ronny Pfannschmidt c49863aa63 merge next chunk from master and fix changelog linting issue 2016-05-13 19:36:47 +02:00
Ronny Pfannschmidt 01d2ff804b Merge commit '56156bb119194014129ac08c4a2c370f0b893104' into merge-master 2016-05-13 17:55:02 +02:00
Ronny Pfannschmidt 68f658b6cc Merge commit '890c2fa555314a67a8d97a1b8ea4881a14be69c4' into merge-master 2016-05-13 17:52:59 +02:00
Ronny Pfannschmidt 4bde70d060 Merge commit 'ec62a3c9e47c3b5b07aa1656815145ffa2882a09' into merge-master 2016-05-13 17:40:14 +02:00
palaviv 53429ed8b8 Added hook to plugin docs and new CHANGELOG record 2016-04-25 18:03:34 +03:00
Ronny Pfannschmidt 52babba33e Update sprint 2016 2016-04-23 08:56:28 +02:00
Ana Ribeiro f02f72e651 Update sprint2016.rst 2016-04-23 00:11:44 -03:00
Florian Bruhin 75160547f2 Use a callable __tracebackhide__ for filtering
While this leads to slightly more complicated user code for the common
case (checking if the exception is of a given type) it's easier to
implement and more flexible.
2016-04-20 11:09:27 +02:00
Florian Bruhin b607f6728f Filter selectively with __tracebackhide__
When __tracebackhide__ gets set to an exception type or list/tuple of
exception types, only those exceptions get filtered, while the full
traceback is shown if another exception (e.g. a bug in a assertion
helper) happens.
2016-04-20 10:25:33 +02:00
Florian Bruhin 98430a17f2 doc: Use ascii chars for file tree
LaTeX doesn't like those particular unicode chars, so let's avoid them so the
PDF builds easily.
2016-04-13 23:38:58 +02:00
Thomas Güttler fb45f82840 Hudson -> Jenkins 2016-04-05 14:08:30 +02:00
Omar Kohl c578226d43 Implement ExceptionInfo.match() to match regexp on str(exception)
This implements similar functionality to
unittest.TestCase.assertRegexpMatches()

closes #372
2016-04-03 11:22:44 +02:00
Bruno Oliveira 53d319144d Mention Pytest::Framework PyPI classifier on docs 2016-03-22 20:42:52 -03:00
Omar Kohl 98c707561c Document --full-trace option and KeyboardInterrupt
fix #513
2016-03-20 20:07:16 +01:00
Omar Kohl a341dddc74 Replace --fulltrace with --full-trace in doc
Since 'py.test --help' shows --full-trace as an option (and not --fulltrace)
even though both forms are accepted I assume --full-trace is the preferred form
and should therefore be used in the documentation.
2016-03-20 19:51:23 +01:00
Omar Kohl 16e49d96d1 Replace --traceconfig with --trace-config in doc
Since 'py.test --help' shows --trace-config as an option (and not
--traceconfig) even though both forms are accepted I assume --trace-config is
the preferred form and should therefore be used in the documentation.
2016-03-20 17:12:50 +01:00
Omar Kohl ec62a3c9e4 Fix minor typo in 'writing plugins' doc 2016-03-20 17:01:04 +01:00
Omar Kohl f70ed83479 Fix 'test grouping by fixture instances' doc example
The fin() function was never added as a finalizer and did therefore not print
anything in the captured output.

In general improve the output by making it more verbose/explicit and extend the
final explanation.
2016-03-20 15:53:32 +01:00
Omar Kohl dff914cadd Add short explanation and link to yield fixtures in fixture doc 2016-03-20 14:10:20 +01:00
Omar Kohl 3135463573 No longer refer to the 'yield fixture mechanism' as experimental (doc)
The feature has been there for a long time and in the 2.7.1 release notes it
says:

> fixed docs to remove the notion that yield-fixtures are experimental.

Therefore this one place was probably just missed.
2016-03-20 13:54:56 +01:00
Omar Kohl 266b53dfc2 Add Jenkins xUnit Plugin link to doc 2016-03-20 13:39:10 +01:00
Omar Kohl bdb3581a52 Fix minor mistake in test discovery doc
The example output shown was for Python3 not Python2.

Add Python2 output and rephrase for clarity.
2016-03-20 13:24:43 +01:00
Omar Kohl 27b62740e3 Fix minor mistake in usage doc (pkg instead of pypkg) 2016-03-20 12:47:17 +01:00
Bruno Oliveira 5fcce8a7d6 Merge branch 'master' into merge-master-into-features 2016-03-18 18:26:56 -03:00
nicoddemus 168daaa71f Regendocs 2016-03-17 17:13:41 -04:00
nicoddemus 43fc1b47c0 Add announce doc 2016-03-17 17:10:02 -04:00
Florian Bruhin 1d35a03812 Update talks page 2016-03-17 06:37:49 +01:00
Tareq Alayan fa6acdcfd4 junitxml: add properties node in testsuite level
The commit allow users to add a properties node in testsuite level see
example below:

<testsuite errors="0" failures="0" name="pytest" skips="1" tests="1"
time="11.824">
  <properties>
    <property name="ARCH" value="PPC"/>
    <property name="OS" value="RHEL 7.2"/>
    <property name="TestPlanURL" value="https://url.."/>
    <property name="Automated" value="True"/>
  </properties>
  <testcase classname="git.....>
  </testcase>
</testsuite>

The current situation is that properties node can be added to every
testcase node. However, sometimes we need some global properties that
applies to all testcases and give better description for the testsuite
itself.
2016-03-16 13:24:33 +02:00
Kale Kundert 5dab0954a0 Add approx() to the Sphinx docs. 2016-03-07 18:14:49 -08:00
Bruno Oliveira 28937a5cd9 Add versionadded directive to doctest_namespace section 2016-03-02 23:37:51 -03:00
Matt Williams 6dd2ff5332 Correct indentation in documentation 2016-03-02 13:02:15 +00:00
Matt Williams 891e029518 Add a new doctest_namespace fixture
This fixture can be used to inject names into the namespace in which
your doctests run.
2016-03-02 12:43:57 +00:00
Bruno Oliveira e656dbb602 Merge branch 'release-290' 2016-03-01 18:45:33 -03:00
Floris Bruynooghe 63b69326b8 Add company name to flub in sprint attendees 2016-03-01 10:17:31 +00:00
nicoddemus 19d05814d2 Fix reference to _CallOutcome in docs 2016-02-29 17:09:31 -05:00
nicoddemus 7d2b65813e Fix typo in CHANGELOG 2016-02-29 16:48:28 -05:00
nicoddemus f82c03833f Regendocs 2016-02-29 15:52:56 -05:00