6.2.3

pytest 6.2.3 (2021-04-03)

Bug Fixes

• #8414: pytest used to create directories under /tmp with world-readable
  permissions. This means that any user in the system was able to read
  information written by tests in temporary directories (such as those created by
  the tmp_path/tmpdir fixture). Now the directories are created with
  private permissions.

  pytest used silenty use a pre-existing /tmp/pytest-of-<username> directory,
  even if owned by another user. This means another user could pre-create such a
  directory and gain control of another user's temporary directory. Now such a
  condition results in an error.

6.2.2

pytest 6.2.2 (2021-01-25)

Bug Fixes

• #8152: Fixed "(<Skipped instance>)" being shown as a skip reason in the verbose test summary line when the reason is empty.
• #8249: Fix the faulthandler plugin for occasions when running with twisted.logger and using pytest --capture=no.

6.2.1

pytest 6.2.1 (2020-12-15)

Bug Fixes

• #7678: Fixed bug where ImportPathMismatchError would be raised for files compiled in
  the host and loaded later from an UNC mounted path (Windows).

• #8132: Fixed regression in approx: in 6.2.0 approx no longer raises
  TypeError when dealing with non-numeric types, falling back to normal comparison.
  Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case,
  and happened to compare correctly to a scalar if they had only one element.
  After 6.2.0, these types began failing, because they inherited neither from
  standard Python number hierarchy nor from numpy.ndarray.

  approx now converts arguments to numpy.ndarray if they expose the array
  protocol and are not scalars. This treats array-like objects like numpy arrays,
  regardless of size.

6.2.0

pytest 6.2.0 (2020-12-12)

Breaking Changes

• #7808: pytest now supports python3.6+ only.

Deprecations

• #7469: Directly constructing/calling the following classes/functions is now deprecated:

  • _pytest.cacheprovider.Cache
  • _pytest.cacheprovider.Cache.for_config()
  • _pytest.cacheprovider.Cache.clear_cache()
  • _pytest.cacheprovider.Cache.cache_dir_from_config()
  • _pytest.capture.CaptureFixture
  • _pytest.fixtures.FixtureRequest
  • _pytest.fixtures.SubRequest
  • _pytest.logging.LogCaptureFixture
  • _pytest.pytester.Pytester
  • _pytest.pytester.Testdir
  • _pytest.recwarn.WarningsRecorder
  • _pytest.recwarn.WarningsChecker
  • _pytest.tmpdir.TempPathFactory
  • _pytest.tmpdir.TempdirFactory

  These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 7.0.0.

• #7530: The --strict command-line option has been deprecated, use --strict-markers instead.

  We have plans to maybe in the future to reintroduce --strict and make it an encompassing flag for all strictness
  related options (--strict-markers and --strict-config at the moment, more might be introduced in the future).

• #7988: The @pytest.yield_fixture decorator/function is now deprecated. Use pytest.fixture instead.

  yield_fixture has been an alias for fixture for a very long time, so can be search/replaced safely.

Features

• #5299: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8.
  See unraisable for more information.

• #7425: New pytester fixture, which is identical to testdir but its methods return pathlib.Path when appropriate instead of py.path.local.

  This is part of the movement to use pathlib.Path objects internally, in order to remove the dependency to py in the future.

  Internally, the old Testdir <_pytest.pytester.Testdir> is now a thin wrapper around Pytester <_pytest.pytester.Pytester>, preserving the old interface.

• #7695: A new hook was added, pytest_markeval_namespace which should return a dictionary.
  This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers.

  Pseudo example

  conftest.py:

  def pytest_markeval_namespace():
      return {"color": "red"}
  

  test_func.py:

  @pytest.mark.skipif("color == 'blue'", reason="Color is not red")
  def test_func():
      assert False
  

• #8006: It is now possible to construct a ~pytest.MonkeyPatch object directly as pytest.MonkeyPatch(),
  in cases when the monkeypatch fixture cannot be used. Previously some users imported it
  from the private _pytest.monkeypatch.MonkeyPatch namespace.

  Additionally, MonkeyPatch.context <pytest.MonkeyPatch.context> is now a classmethod,
  and can be used as with MonkeyPatch.context() as mp: .... This is the recommended way to use
  MonkeyPatch directly, since unlike the monkeypatch fixture, an instance created directly
  is not undo()-ed automatically.

Improvements

• #1265: Added an __str__ implementation to the ~pytest.pytester.LineMatcher class which is returned from pytester.run_pytest().stdout and similar. It returns the entire output, like the existing str() method.

• #2044: Verbose mode now shows the reason that a test was skipped in the test's terminal line after the "SKIPPED", "XFAIL" or "XPASS".

• #7469 The types of builtin pytest fixtures are now exported so they may be used in type annotations of test functions.
  The newly-exported types are:

  • pytest.FixtureRequest for the request fixture.
  • pytest.Cache for the cache fixture.
  • pytest.CaptureFixture[str] for the capfd and capsys fixtures.
  • pytest.CaptureFixture[bytes] for the capfdbinary and capsysbinary fixtures.
  • pytest.LogCaptureFixture for the caplog fixture.
  • pytest.Pytester for the pytester fixture.
  • pytest.Testdir for the testdir fixture.
  • pytest.TempdirFactory for the tmpdir_factory fixture.
  • pytest.TempPathFactory for the tmp_path_factory fixture.
  • pytest.MonkeyPatch for the monkeypatch fixture.
  • pytest.WarningsRecorder for the recwarn fixture.

  Constructing them is not supported (except for MonkeyPatch); they are only meant for use in type annotations.
  Doing so will emit a deprecation warning, and may become a hard-error in pytest 7.0.

  Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.

• #7527: When a comparison between namedtuple <collections.namedtuple> instances of the same type fails, pytest now shows the differing field names (possibly nested) instead of their indexes.

• #7615: Node.warn <_pytest.nodes.Node.warn> now permits any subclass of Warning, not just PytestWarning <pytest.PytestWarning>.

• #7701: Improved reporting when using --collected-only. It will now show the number of collected tests in the summary stats.

• #7710: Use strict equality comparison for non-numeric types in pytest.approx instead of
  raising TypeError.

  This was the undocumented behavior before 3.7, but is now officially a supported feature.

• #7938: New --sw-skip argument which is a shorthand for --stepwise-skip.

• #8023: Added 'node_modules' to default value for norecursedirs.

• #8032: doClassCleanups <unittest.TestCase.doClassCleanups> (introduced in unittest in Python and 3.8) is now called appropriately.

Bug Fixes

• #4824: Fixed quadratic behavior and improved performance of collection of items using autouse fixtures and xunit fixtures.
• #7758: Fixed an issue where some files in packages are getting lost from --lf even though they contain tests that failed. Regressed in pytest 5.4.0.
• #7911: Directories created by by tmp_path and tmpdir are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.
• #7913: Fixed a crash or hang in pytester.spawn <_pytest.pytester.Pytester.spawn> when the readline module is involved.
• #7951: Fixed handling of recursive symlinks when collecting tests.
• #7981: Fixed symlinked directories not being followed during collection. Regressed in pytest 6.1.0.
• #8016: Fixed only one doctest being collected when using pytest --doctest-modules path/to/an/__init__.py.

Improved Documentation

• #7429: Add more information and use cases about skipping doctests.
• #7780: Classes which should not be inherited from are now marked final class in the API reference.
• #7872: _pytest.config.argparsing.Parser.addini() accepts explicit None and "string".
• #7878: In pull request section, ask to commit after editing changelog and authors file.

Trivial/Internal Changes

• #7802: The attrs dependency requirement is now >=19.2.0 instead of >=17.4.0.
• #8014: .pyc files created by pytest's assertion rewriting now conform to the newer PEP-552 format on Python>=3.7.
  (These files are internal and only interpreted by pytest itself.)

6.1.2

pytest 6.1.2 (2020-10-28)

Bug Fixes

• #7758: Fixed an issue where some files in packages are getting lost from --lf even though they contain tests that failed. Regressed in pytest 5.4.0.
• #7911: Directories created by tmpdir are now considered stale after 3 days without modification (previous value was 3 hours) to avoid deleting directories still in use in long running test suites.

Improved Documentation

• #7815: Improve deprecation warning message for pytest._fillfuncargs().

6.1.1

pytest 6.1.1 (2020-10-03)

Bug Fixes

• #7807: Fixed regression in pytest 6.1.0 causing incorrect rootdir to be determined in some non-trivial cases where parent directories have config files as well.
• #7814: Fixed crash in header reporting when testpaths is used and contains absolute paths (regression in 6.1.0).

6.1.0

pytest 6.1.0 (2020-09-26)

Breaking Changes

• #5585: As per our policy, the following features which have been deprecated in the 5.X series are now
  removed:

  • The funcargnames read-only property of FixtureRequest, Metafunc, and Function classes. Use fixturenames attribute.
  • @pytest.fixture no longer supports positional arguments, pass all arguments by keyword instead.
  • Direct construction of Node subclasses now raise an error, use from_parent instead.
  • The default value for junit_family has changed to xunit2. If you require the old format, add junit_family=xunit1 to your configuration file.
  • The TerminalReporter no longer has a writer attribute. Plugin authors may use the public functions of the TerminalReporter instead of accessing the TerminalWriter object directly.
  • The --result-log option has been removed. Users are recommended to use the pytest-reportlog plugin instead.

  For more information consult
  Deprecations and Removals in the docs.

Deprecations

• #6981: The pytest.collect module is deprecated: all its names can be imported from pytest directly.

• #7097: The pytest._fillfuncargs function is deprecated. This function was kept
  for backward compatibility with an older plugin.

  It's functionality is not meant to be used directly, but if you must replace
  it, use function._request._fillfixtures() instead, though note this is not
  a public API and may break in the future.

• #7210: The special -k '-expr' syntax to -k is deprecated. Use -k 'not expr'
  instead.

  The special -k 'expr:' syntax to -k is deprecated. Please open an issue
  if you use this and want a replacement.

• #7255: The pytest_warning_captured <_pytest.hookspec.pytest_warning_captured> hook is deprecated in favor
  of pytest_warning_recorded <_pytest.hookspec.pytest_warning_recorded>, and will be removed in a future version.

• #7648: The gethookproxy() and isinitpath() methods of FSCollector and Package are deprecated;
  use self.session.gethookproxy() and self.session.isinitpath() instead.
  This should work on all pytest versions.

Features

• #7667: New --durations-min command-line flag controls the minimal duration for inclusion in the slowest list of tests shown by --durations. Previously this was hard-coded to 0.005s.

Improvements

• #6681: Internal pytest warnings issued during the early stages of initialization are now properly handled and can filtered through filterwarnings or --pythonwarnings/-W.

  This also fixes a number of long standing issues: #2891, #7620, #7426.

• #7572: When a plugin listed in required_plugins is missing or an unknown config key is used with --strict-config, a simple error message is now shown instead of a stacktrace.

• #7685: Added two new attributes rootpath <_pytest.config.Config.rootpath> and inipath <_pytest.config.Config.inipath> to Config <_pytest.config.Config>.
  These attributes are pathlib.Path versions of the existing rootdir <_pytest.config.Config.rootdir> and inifile <_pytest.config.Config.inifile> attributes,
  and should be preferred over them when possible.

• #7780: Public classes which are not designed to be inherited from are now marked @final.
  Code which inherits from these classes will trigger a type-checking (e.g. mypy) error, but will still work in runtime.
  Currently the final designation does not appear in the API Reference but hopefully will in the future.

Bug Fixes

• #1953: Fixed error when overwriting a parametrized fixture, while also reusing the super fixture value.

  # conftest.py
  import pytest
  
  
  @pytest.fixture(params=[1, 2])
  def foo(request):
      return request.param
  
  
  # test_foo.py
  import pytest
  
  
  @pytest.fixture
  def foo(foo):
      return foo * 2
  

• #4984: Fixed an internal error crash with IndexError: list index out of range when
  collecting a module which starts with a decorated function, the decorator
  raises, and assertion rewriting is enabled.

• #7591: pylint shouldn't complain anymore about unimplemented abstract methods when inheriting from File <non-python tests>.

• #7628: Fixed test collection when a full path without a drive letter was passed to pytest on Windows (for example \projects\tests\test.py instead of c:\projects\tests\pytest.py).

• #7638: Fix handling of command-line options that appear as paths but trigger an OS-level syntax error on Windows, such as the options used internally by pytest-xdist.

• #7742: Fixed INTERNALERROR when accessing locals / globals with faulty exec.

Improved Documentation

• #1477: Removed faq.rst and its reference in contents.rst.

Trivial/Internal Changes

• #7536: The internal junitxml plugin has rewritten to use xml.etree.ElementTree.
  The order of attributes in XML elements might differ. Some unneeded escaping is
  no longer performed.
• #7587: The dependency on the more-itertools package has been removed.
• #7631: The result type of capfd.readouterr() <_pytest.capture.CaptureFixture.readouterr> (and similar) is no longer a namedtuple,
  but should behave like one in all respects. This was done for technical reasons.
• #7671: When collecting tests, pytest finds test classes and functions by examining the
  attributes of python objects (modules, classes and instances). To speed up this
  process, pytest now ignores builtin attributes (like __class__,
  __delattr__ and __new__) without consulting the python_classes and
  python_functions configuration options and without passing them to plugins
  using the pytest_pycollect_makeitem <_pytest.hookspec.pytest_pycollect_makeitem> hook.

6.0.2

pytest 6.0.2 (2020-09-04)

Bug Fixes

• #7148: Fixed --log-cli potentially causing unrelated print output to be swallowed.
• #7672: Fixed log-capturing level restored incorrectly if caplog.set_level is called more than once.
• #7686: Fixed NotSetType.token being used as the parameter ID when the parametrization list is empty.
  Regressed in pytest 6.0.0.
• #7707: Fix internal error when handling some exceptions that contain multiple lines or the style uses multiple lines (--tb=line for example).

6.0.1

pytest 6.0.1 (2020-07-30)

Bug Fixes

• #7394: Passing an empty help value to Parser.add_option is now accepted instead of crashing when running pytest --help.
  Passing None raises a more informative TypeError.
• #7558: Fix pylint not-callable lint on pytest.mark.parametrize() and the other builtin marks:
  skip, skipif, xfail, usefixtures, filterwarnings.
• #7559: Fix regression in plugins using TestReport.longreprtext (such as pytest-html) when TestReport.longrepr is not a string.
• #7569: Fix logging capture handler's level not reset on teardown after a call to caplog.set_level().

6.0.0

pytest 6.0.0 (2020-07-28)

(Please see the full set of changes for this release also in the 6.0.0rc1 notes below)

Breaking Changes

• #5584: PytestDeprecationWarning are now errors by default.

  Following our plan to remove deprecated features with as little disruption as
  possible, all warnings of type PytestDeprecationWarning now generate errors
  instead of warning messages.

  The affected features will be effectively removed in pytest 6.1, so please consult the
  Deprecations and Removals
  section in the docs for directions on how to update existing code.

  In the pytest 6.0.X series, it is possible to change the errors back into warnings as a
  stopgap measure by adding this to your pytest.ini file:

  [pytest]
  filterwarnings =
      ignore::pytest.PytestDeprecationWarning
  

  But this will stop working when pytest 6.1 is released.

  If you have concerns about the removal of a specific feature, please add a
  comment to #5584.

• #7472: The exec_() and is_true() methods of _pytest._code.Frame have been removed.

Features

• #7464: Added support for NO_COLOR and FORCE_COLOR environment variables to control colored output.

Improvements

• #7467: --log-file CLI option and log_file ini marker now create subdirectories if needed.
• #7489: The pytest.raises function has a clearer error message when match equals the obtained string but is not a regex match. In this case it is suggested to escape the regex.

Bug Fixes

• #7392: Fix the reported location of tests skipped with @pytest.mark.skip when --runxfail is used.
• #7491: tmpdir and tmp_path no longer raise an error if the lock to check for
  stale temporary directories is not accessible.
• #7517: Preserve line endings when captured via capfd.
• #7534: Restored the previous formatting of TracebackEntry.__str__ which was changed by accident.

Improved Documentation

• #7422: Clarified when the usefixtures mark can apply fixtures to test.
• #7441: Add a note about -q option used in getting started guide.

Trivial/Internal Changes

• #7389: Fixture scope package is no longer considered experimental.

pytest 6.0.0rc1 (2020-07-08)

Breaking Changes

• #1316: TestReport.longrepr is now always an instance of ReprExceptionInfo. Previously it was a str when a test failed with pytest.fail(..., pytrace=False).

• #5965: symlinks are no longer resolved during collection and matching conftest.py files with test file paths.

  Resolving symlinks for the current directory and during collection was introduced as a bugfix in 3.9.0, but it actually is a new feature which had unfortunate consequences in Windows and surprising results in other platforms.

  The team decided to step back on resolving symlinks at all, planning to review this in the future with a more solid solution (see discussion in
  #6523 for details).

  This might break test suites which made use of this feature; the fix is to create a symlink
  for the entire test tree, and not only to partial files/tress as it was possible previously.

• #6505: Testdir.run().parseoutcomes() now always returns the parsed nouns in plural form.

  Originally parseoutcomes() would always returns the nouns in plural form, but a change
  meant to improve the terminal summary by using singular form single items (1 warning or 1 error)
  caused an unintended regression by changing the keys returned by parseoutcomes().

  Now the API guarantees to always return the plural form, so calls like this:

  result = testdir.runpytest()
  result.assert_outcomes(error=1)
  

  Need to be changed to:

  result = testdir.runpytest()
  result.assert_outcomes(errors=1)
  

• #6903: The os.dup() function is now assumed to exist. We are not aware of any
  supported Python 3 implementations which do not provide it.

• #7040: -k no longer matches against the names of the directories outside the test session root.

  Also, pytest.Package.name is now just the name of the directory containing the package's
  __init__.py file, instead of the full path. This is consistent with how the other nodes
  are named, and also one of the reasons why -k would match against any directory containing
  the test suite.

• #7122: Expressions given to the -m and -k options are no longer evaluated using Python's eval.
  The format supports or, and, not, parenthesis and general identifiers to match against.
  Python constants, keywords or other operators are no longer evaluated differently.

• #7135: Pytest now uses its own TerminalWriter class instead of using the one from the py library.
  Plugins generally access this class through TerminalReporter.writer, TerminalReporter.write()
  (and similar methods), or _pytest.config.create_terminal_writer().

  The following breaking changes were made:

  • Output (write() method and others) no longer flush implicitly; the flushing behavior
    of the underlying file is respected. To flush explicitly (for example, if you
    want output to be shown before an end-of-line is printed), use write(flush=True) or
    terminal_writer.flush().
  • Explicit Windows console support was removed, delegated to the colorama library.
  • Support for writing bytes was removed.
  • The reline method and chars_on_current_line property were removed.
  • The stringio and encoding arguments was removed.
  • Support for passing a callable instead of a file was removed.

• #7224: The item.catch_log_handler and item.catch_log_handlers attributes, set by the
  logging plugin and never meant to be public , are no longer available.

  The deprecated --no-print-logs option is removed. Use --show-capture instead.

• #7226: Removed the unused args parameter from pytest.Function.__init__.

• #7418: Removed the pytest_doctest_prepare_content hook specification. This hook
  hasn't been triggered by pytest for at least 10 years.

• #7438: Some changes were made to the internal _pytest._code.source, listed here
  for the benefit of plugin authors who may be using it:

  • The deindent argument to Source() has been removed, now it is always true.
  • Support for zero or multiple arguments to Source() has been removed.
  • Support for comparing Source with an str has been removed.
  • The methods Source.isparseable() and Source.putaround() have been removed.
  • The method Source.compile() and function _pytest._code.compile() have
    been removed; use plain compile() instead.
  • The function _pytest._code.source.getsource() has been removed; use
    Source() directly instead.

Deprecations

• #7210: The special -k '-expr' syntax to -k is deprecated. Use -k 'not expr'
  instead.

  The special -k 'expr:' syntax to -k is deprecated. Please open an issue
  if you use this and want a replacement.

• #4049: pytest_warning_captured is deprecated in favor of the pytest_warning_recorded hook.

Features

• #1556: pytest now supports pyproject.toml files for configuration.

  The configuration options is similar to the one available in other formats, but must be defined
  in a [tool.pytest.ini_options] table to be picked up by pytest:

  # pyproject.toml
  [tool.pytest.ini_options]
  minversion = "6.0"
  addopts = "-ra -q"
  testpaths = [
      "tests",
      "integration",
  ]
  

  More information can be found in the docs.

• #3342: pytest now includes inline type annotations and exposes them to user programs.
  Most of the user-facing API is covered, as well as internal code.

  If you are running a type checker such as mypy on your tests, you may start
  noticing type errors indicating incorrect usage. If you run into an error that
  you believe to be incorrect, please let us know in an issu...