jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
test_ok1/changelog
History
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
..
4824.bugfix.rst fixtures: fix quadratic behavior in the number of autouse fixtures 2020-10-25 00:49:23 +03:00
7425.feature.rst New pytester fixture (#7854) 2020-10-12 12:13:06 -03:00
7469.deprecation.rst Export types of builtin fixture for type annotations 2020-11-13 11:25:09 +02:00
7469.improvement.rst Export types of builtin fixture for type annotations 2020-11-13 11:25:09 +02:00
7527.improvement.rst Add support to display field names in namedtuple diffs. 2020-10-31 14:41:53 +02:00
7530.deprecation.rst Deprecate --strict (#7985) 2020-11-06 09:48:20 +01:00
7701.improvement.rst Improve summary stats when using '--collect-only' (#7875) 2020-11-08 11:45:10 -03:00
7710.improvement.rst python_api: let approx() take nonnumeric values (#7710) 2020-09-28 12:17:23 -03:00
7758.bugfix.rst cacheprovider: fix some files in packages getting lost from --lf 2020-10-19 19:02:43 +03:00
7780.doc.rst doc: patch Sphinx to detect our `@final` for marking classes as `final` 2020-10-03 13:13:14 +03:00
7802.trivial.rst Bump attrs requirement from >=17.4.0 to >=19.2.0 2020-09-27 13:17:59 +03:00
7808.breaking.rst py36+: drop python3.5 in CI and setup.cfg 2020-10-02 14:00:11 -07:00
7872.doc.rst Added changelog/7872.doc.rst 2020-10-07 18:06:13 -04:00
7878.doc.rst ask for commit after changelog and authors file edit (#7878) 2020-10-09 16:10:54 +02:00
7911.bugfix.rst Increase temp dir deletion period to 3 days (#7914) 2020-10-28 08:23:35 -03:00
7913.bugfix.rst pytester: workaround issue causing spawn to crash or hang 2020-10-25 16:31:47 +02:00
7938.improvement.rst #7938 - [Plugin: Stepwise][Enhancements] Refactoring, smarter registration & --sw-skip functionality (#7939) 2020-10-30 19:13:06 +00:00
7951.bugfix.rst Fix handling recursive symlinks 2020-10-31 17:40:56 +01:00
7981.bugfix.rst pathlib: fix symlinked directories not followed during collection 2020-10-31 14:22:15 +02:00
7988.deprecation.rst fixtures: deprecate pytest.yield_fixture() 2020-11-07 17:06:40 +02:00
8006.feature.rst Export MonkeyPatch as pytest.MonkeyPatch 2020-11-09 11:28:15 +02:00
README.rst docs: use doc/en/_build/html for html output (#6842) 2020-02-29 00:47:30 +01:00
_template.rst Update CHANGELOG template to put issue links at the start of entries 2018-07-07 11:02:33 -03:00

README.rst 

This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted
text that will be added to the next ``CHANGELOG``.

The ``CHANGELOG`` will be read by **users**, so this description should be aimed to pytest users
instead of describing internal changes which are only relevant to the developers.

Make sure to use full sentences in the **past or present tense** and use punctuation, examples::

    Improved verbose diff output with sequences.

    Terminal summary statistics now use multiple colors.

Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:

* ``feature``: new user facing features, like new command-line options and new behavior.
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
* ``bugfix``: fixes a bug.
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
* ``deprecation``: feature deprecation.
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
* ``vendor``: changes in packages vendored in pytest.
* ``trivial``: fixing a small typo or internal change that might be noteworthy.

So for example: ``123.feature.rst``, ``456.bugfix.rst``.

If your PR fixes an issue, use that number here. If there is no issue,
then after you submit the PR and get the PR number you can add a
changelog using that instead.

If you are not sure what issue type to use, don't hesitate to ask in your PR.

``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries
other than ``features`` it is usually better to stick to a single paragraph to keep it concise.

You can also run ``tox -e docs`` to build the documentation
with the draft changelog (``doc/en/_build/html/changelog.html``) if you want to get a preview of how your change will look in the final release notes.