search

guykisel / inline-plz

Inline your lint messages
ISC License
32 stars 14 forks source link

Scheduled monthly dependency update for October #489

Closed pyup-bot closed 3 years ago

pyup-bot commented 3 years ago

Update bump2version from 0.5.10 to 1.0.0.

Changelog ### 1.0.0 ``` - Fix the spurious newline that bump2version adds when writing to bumpversion.cfg, thanks kyluca 58 - Add Python3.8 support, thanks florisla - Drop Python2 support, thanks hugovk - Allow additional arguments to the commit call, thanks lubomir - Various documentation improvements, thanks lubomir florisla padamstx glotis - Housekeeping, move changelog into own file ``` ### 0.5.11 ``` - Housekeeping, also publish an sdist - Housekeeping, fix appveyor builds - Housekeeping, `make lint` now lints with pylint - Drop support for Python3.4, thanks hugovk 79 - Enhance missing VCS command detection (errno 13), thanks lowell80 75 - Add environment variables for other scripts to use, thanks mauvilsa 70 - Refactor, cli.main is now much more readable, thanks florisla 68 - Fix, retain file newlines for Windows, thanks hesstobi 59 - Add support (tests) for Pythno3.7, thanks florisla 49 - Allow any part to be configured in configurable strings such as tag_name etc., thanks florisla 41 ```
Links - PyPI: https://pypi.org/project/bump2version - Changelog: https://pyup.io/changelogs/bump2version/ - Repo: https://github.com/c4urself/bump2version

Update wheel from 0.33.1 to 0.35.1.

Changelog ### 0.35.0 ``` - Switched to the packaging_ library for computing wheel tags - Fixed a resource leak in ``WheelFile.open()`` (PR by Jon Dufresne) .. _packaging: https://pypi.org/project/packaging/ ``` ### 0.34.2 ``` - Fixed installation of ``wheel`` from sdist on environments without Unicode file name support ``` ### 0.34.1 ``` - Fixed installation of ``wheel`` from sdist which was broken due to a chicken and egg problem with PEP 517 and setuptools_scm ``` ### 0.34.0 ``` - Dropped Python 3.4 support - Added automatic platform tag detection for macOS binary wheels (PR by Grzegorz Bokota) - Added the ``--compression=`` option to the ``bdist_wheel`` command - Fixed PyPy tag generation to work with the updated semantics (328) - Updated project packaging and testing configuration for :pep:`517` - Moved the contents of setup.py to setup.cfg - Fixed duplicate RECORD file when using ``wheel pack`` on Windows - Fixed bdist_wheel failing at cleanup on Windows with a read-only source tree - Fixed ``wheel pack`` not respecting the existing build tag in ``WHEEL`` - Switched the project to use the "src" layout - Switched to setuptools_scm_ for versioning .. _setuptools_scm: https://github.com/pypa/setuptools_scm/ ``` ### 0.33.6 ``` - Fixed regression from 0.33.5 that broke building binary wheels against the limited ABI - Fixed egg2wheel compatibility with the future release of Python 3.10 (PR by Anthony Sottile) ``` ### 0.33.5 ``` - Don't add the ``m`` ABI flag to wheel names on Python 3.8 (PR by rdb) - Updated ``MANIFEST.in`` to include many previously omitted files in the sdist ``` ### 0.33.4 ``` - Reverted PR 289 (adding directory entries to the wheel file) due to incompatibility with ``distlib.wheel`` ``` ### 0.33.3 ``` - Fixed wheel build failures on some systems due to all attributes being preserved (PR by Matt Wozniski) ``` ### 0.33.2 ``` - Fixed empty directories missing from the wheel (PR by Jason R. Coombs) ```
Links - PyPI: https://pypi.org/project/wheel - Changelog: https://pyup.io/changelogs/wheel/ - Repo: https://github.com/pypa/wheel

Update watchdog from 0.9.0 to 0.10.3.

Changelog ### 0.10.3 ``` ~~~~~~ 2020-06-25 • `full history <https://github.com/gorakhargosh/watchdog/compare/v0.10.2...v0.10.3>`__ - Ensure ``ObservedWatch.path`` is a string (`651 <https://github.com/gorakhargosh/watchdog/pull/651>`_) - [inotify] Allow to monitor single file (`655 <https://github.com/gorakhargosh/watchdog/pull/655>`__) - [inotify] Prevent raising an exception when a file in a monitored folder has no permissions (`669 <https://github.com/gorakhargosh/watchdog/pull/669>`__, `670 <https://github.com/gorakhargosh/watchdog/pull/670>`__) - Thanks to our beloved contributors: brant-ruan, rec, andfoy, BoboTiG ``` ### 0.10.2 ``` ~~~~~~ 2020-02-08 • `full history <https://github.com/gorakhargosh/watchdog/compare/v0.10.1...v0.10.2>`__ - Fixed the ``build_ext`` command on macOS Catalina (`628 <https://github.com/gorakhargosh/watchdog/pull/628>`__) - Fixed the installation of macOS requirements on non-macOS OSes (`635 <https://github.com/gorakhargosh/watchdog/pull/635>`__) - Refactored ``dispatch()`` method of ``FileSystemEventHandler``, ``PatternMatchingEventHandler`` and ``RegexMatchingEventHandler`` - [bsd] Improved tests support on non Windows/Linux platforms (`633 <https://github.com/gorakhargosh/watchdog/pull/633>`__, `639 <https://github.com/gorakhargosh/watchdog/pull/639>`__) - [bsd] Added FreeBSD CI support (`532 <https://github.com/gorakhargosh/watchdog/pull/532>`__) - [bsd] Restored full support (`638 <https://github.com/gorakhargosh/watchdog/pull/638>`__, `641 <https://github.com/gorakhargosh/watchdog/pull/641>`__) - Thanks to our beloved contributors: BoboTiG, evilham, danilobellini ``` ### 0.10.1 ``` ~~~~~~ 2020-01-30 • `full history <https://github.com/gorakhargosh/watchdog/compare/v0.10.0...v0.10.1>`__ - Fixed Python 2.7 to 3.6 installation when the OS locale is set to POSIX (`615 <https://github.com/gorakhargosh/watchdog/pull/615>`__) - Fixed the ``build_ext`` command on macOS (`618 <https://github.com/gorakhargosh/watchdog/pull/618>`__, `620 <https://github.com/gorakhargosh/watchdog/pull/620>`_) - Moved requirements to ``setup.cfg`` (`617 <https://github.com/gorakhargosh/watchdog/pull/617>`__) - [mac] Removed old C code for Python 2.5 in the `fsevents` C implementation - [snapshot] Added ``EmptyDirectorySnapshot`` (`613 <https://github.com/gorakhargosh/watchdog/pull/613>`__) - Thanks to our beloved contributors: Ajordat, tehkirill, BoboTiG ``` ### 0.10.0 ``` ~~~~~~ 2020-01-26 • `full history <https://github.com/gorakhargosh/watchdog/compare/v0.9.0...v0.10.0>`__ **Breaking Changes** - Dropped support for Python 2.6, 3.2 and 3.3 - Emitters that failed to start are now removed - [snapshot] Removed the deprecated ``walker_callback`` argument, use ``stat`` instead - [watchmedo] The utility is no more installed by default but via the extra ``watchdog[watchmedo]`` **Other Changes** - Fixed several Python 3 warnings - Identify synthesized events with ``is_synthetic`` attribute (`369 <https://github.com/gorakhargosh/watchdog/pull/369>`__) - Use ``os.scandir()`` to improve memory usage (`503 <https://github.com/gorakhargosh/watchdog/pull/503>`__) - [bsd] Fixed flavors of FreeBSD detection (`529 <https://github.com/gorakhargosh/watchdog/pull/529>`__) - [bsd] Skip unprocessable socket files (`509 <https://github.com/gorakhargosh/watchdog/issue/509>`__) - [inotify] Fixed events containing non-ASCII characters (`516 <https://github.com/gorakhargosh/watchdog/issues/516>`__) - [inotify] Fixed the way ``OSError`` are re-raised (`377 <https://github.com/gorakhargosh/watchdog/issues/377>`__) - [inotify] Fixed wrong source path after renaming a top level folder (`515 <https://github.com/gorakhargosh/watchdog/pull/515>`__) - [inotify] Removed delay from non-move events (`477 <https://github.com/gorakhargosh/watchdog/pull/477>`__) - [mac] Fixed a bug when calling ``FSEventsEmitter.stop()`` twice (`466 <https://github.com/gorakhargosh/watchdog/pull/466>`__) - [mac] Support for unscheduling deleted watch (`541 <https://github.com/gorakhargosh/watchdog/issue/541>`__) - [mac] Fixed missing field initializers and unused parameters in ``watchdog_fsevents.c`` - [snapshot] Don't walk directories without read permissions (`408 <https://github.com/gorakhargosh/watchdog/pull/408>`__) - [snapshot] Fixed a race condition crash when a directory is swapped for a file (`513 <https://github.com/gorakhargosh/watchdog/pull/513>`__) - [snasphot] Fixed an ``AttributeError`` about forgotten ``path_for_inode`` attr (`436 <https://github.com/gorakhargosh/watchdog/issues/436>`__) - [snasphot] Added the ``ignore_device=False`` parameter to the ctor (`597 <https://github.com/gorakhargosh/watchdog/pull/597>`__) - [watchmedo] Fixed the path separator used (`478 <https://github.com/gorakhargosh/watchdog/pull/478>`__) - [watchmedo] Fixed the use of ``yaml.load()`` for ``yaml.safe_load()`` (`453 <https://github.com/gorakhargosh/watchdog/issues/453>`__) - [watchmedo] Handle all available signals (`549 <https://github.com/gorakhargosh/watchdog/issue/549>`__) - [watchmedo] Added the ``--debug-force-polling`` argument (`404 <https://github.com/gorakhargosh/watchdog/pull/404>`__) - [windows] Fixed issues when the observed directory is deleted (`570 <https://github.com/gorakhargosh/watchdog/issues/570>`__ and `601 <https://github.com/gorakhargosh/watchdog/pull/601>`__) - [windows] ``WindowsApiEmitter`` made easier to subclass (`344 <https://github.com/gorakhargosh/watchdog/pull/344>`__) - [windows] Use separate ctypes DLL instances - [windows] Generate sub created events only if ``recursive=True`` (`454 <https://github.com/gorakhargosh/watchdog/pull/454>`__) - Thanks to our beloved contributors: BoboTiG, LKleinNux, rrzaripov, wildmichael, TauPan, segevfiner, petrblahos, QuantumEnergyE, jeffwidman, kapsh, nickoala, petrblahos, julianolf, tonybaloney, mbakiev, pR0Ps, javaguirre, skurfer, exarkun, joshuaskelly, danilobellini, Ajordat ```
Links - PyPI: https://pypi.org/project/watchdog - Changelog: https://pyup.io/changelogs/watchdog/ - Repo: http://github.com/gorakhargosh/watchdog - Docs: https://pythonhosted.org/watchdog/

Update flake8 from 3.7.7 to 3.8.3.

Changelog ### 3.8.3 ``` ------------------- You can view the `3.8.3 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Also catch ``SyntaxError`` when tokenizing (See also `GitLab!433`_, `GitLab662`_) - Fix ``--jobs`` default display in ``flake8 --help`` (See also `GitLab!434`_, `GitLab665`_) .. all links .. _3.8.3 milestone: https://gitlab.com/pycqa/flake8/-/milestones/36 .. issue links .. _GitLab662: https://gitlab.com/pycqa/flake8/issues/662 .. _GitLab665: https://gitlab.com/pycqa/flake8/issues/665 .. merge request links .. _GitLab!433: https://gitlab.com/pycqa/flake8/merge_requests/433 .. _GitLab!434: https://gitlab.com/pycqa/flake8/merge_requests/434 ``` ### 3.8.2 ``` ------------------- You can view the `3.8.2 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Improve performance by eliminating unncessary sort (See also `GitLab!429`_) - Improve messaging of ``--jobs`` argument by utilizing ``argparse`` (See also `GitLab!428`_, `GitLab567`_) - Fix file configuration options to be relative to the config passed on the command line (See also `GitLab!431`_, `GitLab651`_) - Fix incorrect handling of ``--extend-exclude`` by treating its values as files (See also `GitLab!432`_, `GitLab653`_) .. all links .. _3.8.2 milestone: https://gitlab.com/pycqa/flake8/-/milestones/35 .. issue links .. _GitLab567: https://gitlab.com/pycqa/flake8/issues/567 .. _GitLab651: https://gitlab.com/pycqa/flake8/issues/651 .. _GitLab653: https://gitlab.com/pycqa/flake8/issues/653 .. merge request links .. _GitLab!428: https://gitlab.com/pycqa/flake8/merge_requests/428 .. _GitLab!429: https://gitlab.com/pycqa/flake8/merge_requests/429 .. _GitLab!431: https://gitlab.com/pycqa/flake8/merge_requests/431 .. _GitLab!432: https://gitlab.com/pycqa/flake8/merge_requests/432 ``` ### 3.8.1 ``` ------------------- You can view the `3.8.1 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix ``--output-file`` (regression in 3.8.0) (See also `GitLab!427`_, `GitLab637`_) .. all links .. _3.8.1 milestone: https://gitlab.com/pycqa/flake8/-/milestones/34 .. issue links .. _GitLab637: https://gitlab.com/pycqa/flake8/issues/637 .. merge request links .. _GitLab!427: https://gitlab.com/pycqa/flake8/merge_requests/427 ``` ### 3.8.0 ``` ------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix logical checks which report positions out of bounds (See also `GitLab!422`_, `GitLab635`_) - Fix ``--exclude=.*`` accidentally matching ``.`` and ``..`` (See also `GitLab!424`_, `GitLab632`_) Deprecations ~~~~~~~~~~~~ - Add deprecation message for vcs hooks (See also `GitLab!420`_, `GitLab568`_) ``` ### 3.8.0a2 ``` --------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix ``type="str"`` optparse options (See also `GitLab!419`_) ``` ### 3.8.0a1 ``` --------------------- You can view the `3.8.0 milestone`_ on GitLab for more details. New Dependency Information ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Remove dependency on ``entrypoints`` and add dependency on ``importlib-metadata`` (only for ``python<3.8``) (See also `GitLab!388`_, `GitLab569`_) - Pyflakes has been updated to >= 2.2.0, < 2.3.0 (See also `GitLab!417`_) - pycodestyle has been updated to >= 2.6.0a1, < 2.7.0 (See also `GitLab!418`_) Features ~~~~~~~~ - Add ``--extend-exclude`` option to add to ``--exclude`` without overwriting (See also `GitLab!315`_, `GitLab535`_) - Move argument parsing from ``optparse`` to ``argparse`` (See also `GitLab!341`_ - Group plugin options in ``--help`` (See also `GitLab!342`_, `GitLab565`_) - Remove parsing of ``verbose`` from configuration files as it was not consistently applied (See also `GitLab!360`_, `GitLab439`_) - Remove parsing of ``output_file`` from configuration files as it was not consistently applied (See also `GitLab!361`_) - Resolve configuration files relative to ``cwd`` instead of common prefix of passed filenames. You may need to change ``flake8 subproject`` to ``cd subproject && flake8 .`` (See also `GitLab!363`_) - Officially support python3.8 (See also `GitLab!377`_) - ``--disable-noqa`` now also disables `` flake8: noqa`` (See also `GitLab!380`_, `GitLab590`_) - Ensure that a missing file produces a ``E902`` error (See also `GitLab!404`_, `GitLab600`_) - `` noqa`` comments now apply to all of the lines in an explicit ``\`` continuation or in a line continued by a multi-line string (See also `GitLab!413`_, `GitLab375`_) Bugs Fixed ~~~~~~~~~~ - Fix ``--exclude=./t.py`` to only match ``t.py`` at the top level (See also `GitLab!311`_, `GitLab382`_) - Fix ``--show-source`` when a file is indented with tabs (See also `GitLab!339`_, `GitLab563`_) - Fix crash when ``--max-line-length`` is given a non-integer (See also `GitLab!341`_, `GitLab541`_) - Prevent flip-flopping of ``indent_char`` causing extra ``E101`` errors (See also `GitLab!357`_, `pycodestyle886`_) - Only enable multiprocessing when the method is ``fork`` fixing issues on macos with python3.8+ (See also `GitLab!366`_, `GitLab587`_) (note: this fix also landed in 3.7.9) - ``noqa`` is now only handled by flake8 fixing specific-noqa. Plugins requesting this parameter will always receive ``False`` (See also `GitLab!331`_, `GitLab552`_) - Fix duplicate loading of plugins when invoked via ``python -m flake8`` (See also `GitLab!388`_) - Fix early exit when ``--exit-zero`` and ``--diff`` are provided and the diff is empty (See also `GitLab!391`_) - Consistently split lines when ``\f`` is present when reading from stdin (See also `GitLab!406`_, `GitLab270`_) Deprecations ~~~~~~~~~~~~ - ``python setup.py flake8`` (setuptools integration) is now deprecated and will be removed in a future version (See also `GitLab!330`_, `GitLab544`_) - ``type='string'`` (optparse) types are deprecated, use ``type=callable`` (argparse) instead. Support for ``type='string'`` will be removed in a future version (See also `GitLab!341`_) - ``%default`` in plugin option help text is deprecated, use ``%(default)s`` instead. Support for ``%default`` will be removed in a future version (See also `GitLab!341`_) - optparse-style ``action='callback'`` setting for options is deprecated, use argparse action classes instead. This will be removed in a future version (See also `GitLab!341`_) .. all links .. _3.8.0 milestone: https://gitlab.com/pycqa/flake8/-/milestones/32 .. merge request links .. _GitLab270: https://gitlab.com/pycqa/flake8/-/issues/270 .. _GitLab375: https://gitlab.com/pycqa/flake8/-/issues/375 .. _GitLab382: https://gitlab.com/pycqa/flake8/-/issues/382 .. _GitLab439: https://gitlab.com/pycqa/flake8/-/issues/439 .. _GitLab535: https://gitlab.com/pycqa/flake8/-/issues/535 .. _GitLab541: https://gitlab.com/pycqa/flake8/-/issues/541 .. _GitLab544: https://gitlab.com/pycqa/flake8/-/issues/544 .. _GitLab552: https://gitlab.com/pycqa/flake8/-/issues/552 .. _GitLab563: https://gitlab.com/pycqa/flake8/-/issues/563 .. _GitLab565: https://gitlab.com/pycqa/flake8/-/issues/565 .. _GitLab568: https://gitlab.com/pycqa/flake8/-/issues/568 .. _GitLab569: https://gitlab.com/pycqa/flake8/-/issues/569 .. _GitLab587: https://gitlab.com/pycqa/flake8/-/issues/587 .. _GitLab590: https://gitlab.com/pycqa/flake8/-/issues/590 .. _GitLab600: https://gitlab.com/pycqa/flake8/-/issues/600 .. _GitLab632: https://gitlab.com/pycqa/flake8/-/issues/632 .. _GitLab635: https://gitlab.com/pycqa/flake8/-/issues/635 .. _pycodestyle886: https://github.com/PyCQA/pycodestyle/issues/886 .. issue links .. _GitLab!311: https://gitlab.com/pycqa/flake8/-/merge_requests/311 .. _GitLab!315: https://gitlab.com/pycqa/flake8/-/merge_requests/315 .. _GitLab!330: https://gitlab.com/pycqa/flake8/-/merge_requests/330 .. _GitLab!331: https://gitlab.com/pycqa/flake8/-/merge_requests/331 .. _GitLab!339: https://gitlab.com/pycqa/flake8/-/merge_requests/339 .. _GitLab!341: https://gitlab.com/pycqa/flake8/-/merge_requests/341 .. _GitLab!342: https://gitlab.com/pycqa/flake8/-/merge_requests/342 .. _GitLab!357: https://gitlab.com/pycqa/flake8/-/merge_requests/357 .. _GitLab!360: https://gitlab.com/pycqa/flake8/-/merge_requests/360 .. _GitLab!361: https://gitlab.com/pycqa/flake8/-/merge_requests/361 .. _GitLab!363: https://gitlab.com/pycqa/flake8/-/merge_requests/363 .. _GitLab!366: https://gitlab.com/pycqa/flake8/-/merge_requests/366 .. _GitLab!377: https://gitlab.com/pycqa/flake8/-/merge_requests/377 .. _GitLab!380: https://gitlab.com/pycqa/flake8/-/merge_requests/380 .. _GitLab!388: https://gitlab.com/pycqa/flake8/-/merge_requests/388 .. _GitLab!391: https://gitlab.com/pycqa/flake8/-/merge_requests/391 .. _GitLab!404: https://gitlab.com/pycqa/flake8/-/merge_requests/404 .. _GitLab!406: https://gitlab.com/pycqa/flake8/-/merge_requests/406 .. _GitLab!413: https://gitlab.com/pycqa/flake8/-/merge_requests/413 .. _GitLab!417: https://gitlab.com/pycqa/flake8/-/merge_requests/417 .. _GitLab!418: https://gitlab.com/pycqa/flake8/-/merge_requests/418 .. _GitLab!419: https://gitlab.com/pycqa/flake8/-/merge_requests/419 .. _GitLab!420: https://gitlab.com/pycqa/flake8/-/merge_requests/420 .. _GitLab!422: https://gitlab.com/pycqa/flake8/-/merge_requests/422 .. _GitLab!424: https://gitlab.com/pycqa/flake8/-/merge_requests/424 ``` ### 3.7.9 ``` ------------------- You can view the `3.7.9 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Disable multiprocessing when the multiprocessing method is ``spawn`` (such as on macos in python3.8) (See also `GitLab!367`_, `GitLab587`_) .. all links .. _3.7.9 milestone: https://gitlab.com/pycqa/flake8/milestones/33 .. issue links .. _GitLab587: https://gitlab.com/pycqa/flake8/issues/587 .. merge request links .. _GitLab!367: https://gitlab.com/pycqa/flake8/merge_requests/367 ``` ### 3.7.8 ``` ------------------- You can view the `3.7.8 milestone`_ on GitLab for more details. Bugs Fixed ~~~~~~~~~~ - Fix handling of ``Application.parse_preliminary_options_and_args`` when argv is an empty list (See also `GitLab!310`_, `GitLab518`_) - Fix crash when a file parses but fails to tokenize (See also `GitLab!314`_, `GitLab532`_) - Log the full traceback on plugin exceptions (See also `GitLab!317`_) - Fix `` noqa: ...`` comments with multi-letter codes (See also `GitLab!326`_, `GitLab549`_) .. all links .. _3.7.8 milestone: https://gitlab.com/pycqa/flake8/milestones/31 .. issue links .. _GitLab518: https://gitlab.com/pycqa/flake8/issues/518 .. _GitLab532: https://gitlab.com/pycqa/flake8/issues/532 .. _GitLab549: https://gitlab.com/pycqa/flake8/issues/549 .. merge request links .. _GitLab!310: https://gitlab.com/pycqa/flake8/merge_requests/310 .. _GitLab!314: https://gitlab.com/pycqa/flake8/merge_requests/314 .. _GitLab!317: https://gitlab.com/pycqa/flake8/merge_requests/317 .. _GitLab!326: https://gitlab.com/pycqa/flake8/merge_requests/326 ```
Links - PyPI: https://pypi.org/project/flake8 - Changelog: https://pyup.io/changelogs/flake8/ - Repo: https://gitlab.com/pycqa/flake8

Update tox from 3.7.0 to 3.20.0.

The bot wasn't able to find a changelog for this release. Got an idea?

Links - PyPI: https://pypi.org/project/tox - Docs: http://tox.readthedocs.org

Update coverage from 4.5.2 to 5.3.

Changelog ### 5.3 ``` -------------------------- - The ``source`` setting has always been interpreted as either a file path or a module, depending on which existed. If both interpretations were valid, it was assumed to be a file path. The new ``source_pkgs`` setting can be used to name a package to disambiguate this case. Thanks, Thomas Grainger. Fixes `issue 268`_. - If a plugin was disabled due to an exception, we used to still try to record its information, causing an exception, as reported in `issue 1011`_. This is now fixed. .. _issue 268: https://github.com/nedbat/coveragepy/issues/268 .. _issue 1011: https://github.com/nedbat/coveragepy/issues/1011 .. _changes_521: ``` ### 5.2.1 ``` ---------------------------- - The dark mode HTML report still used light colors for the context listing, making them unreadable (`issue 1009`_). This is now fixed. - The time stamp on the HTML report now includes the time zone. Thanks, Xie Yanbo (`pull request 960`_). .. _pull request 960: https://github.com/nedbat/coveragepy/pull/960 .. _issue 1009: https://github.com/nedbat/coveragepy/issues/1009 .. _changes_52: ``` ### 5.2 ``` -------------------------- - The HTML report has been redesigned by Vince Salvino. There is now a dark mode, the code text is larger, and system sans serif fonts are used, in addition to other small changes (`issue 858`_ and `pull request 931`_). - The ``coverage report`` and ``coverage html`` commands now accept a ``--precision`` option to control the number of decimal points displayed. Thanks, Teake Nutma (`pull request 982`_). - The ``coverage report`` and ``coverage html`` commands now accept a ``--no-skip-covered`` option to negate ``--skip-covered``. Thanks, Anthony Sottile (`issue 779`_ and `pull request 932`_). - The ``--skip-empty`` option is now available for the XML report, closing `issue 976`_. - The ``coverage report`` command now accepts a ``--sort`` option to specify how to sort the results. Thanks, Jerin Peter George (`pull request 1005`_). - If coverage fails due to the coverage total not reaching the ``--fail-under`` value, it will now print a message making the condition clear. Thanks, Naveen Yadav (`pull request 977`_). - TOML configuration files with non-ASCII characters would cause errors on Windows (`issue 990`_). This is now fixed. - The output of ``--debug=trace`` now includes information about how the ``--source`` option is being interpreted, and the module names being considered. .. _pull request 931: https://github.com/nedbat/coveragepy/pull/931 .. _pull request 932: https://github.com/nedbat/coveragepy/pull/932 .. _pull request 977: https://github.com/nedbat/coveragepy/pull/977 .. _pull request 982: https://github.com/nedbat/coveragepy/pull/982 .. _pull request 1005: https://github.com/nedbat/coveragepy/pull/1005 .. _issue 779: https://github.com/nedbat/coveragepy/issues/779 .. _issue 858: https://github.com/nedbat/coveragepy/issues/858 .. _issue 976: https://github.com/nedbat/coveragepy/issues/976 .. _issue 990: https://github.com/nedbat/coveragepy/issues/990 .. _changes_51: ``` ### 5.1 ``` -------------------------- - The JSON report now includes counts of covered and missing branches. Thanks, Salvatore Zagaria. - On Python 3.8, try-finally-return reported wrong branch coverage with decorated async functions (`issue 964`_). This is now fixed. Thanks, Kjell Braden. - The :meth:`~coverage.Coverage.get_option` and :meth:`~coverage.Coverage.set_option` methods can now manipulate the ``[paths]`` configuration setting. Thanks to Bernát Gábor for the fix for `issue 967`_. .. _issue 964: https://github.com/nedbat/coveragepy/issues/964 .. _issue 967: https://github.com/nedbat/coveragepy/issues/967 .. _changes_504: ``` ### 5.0.4 ``` ---------------------------- - If using the ``[run] relative_files`` setting, the XML report will use relative files in the ``<source>`` elements indicating the location of source code. Closes `issue 948`_. - The textual summary report could report missing lines with negative line numbers on PyPy3 7.1 (`issue 943`_). This is now fixed. - Windows wheels for Python 3.8 were incorrectly built, but are now fixed. (`issue 949`_) - Updated Python 3.9 support to 3.9a4. - HTML reports couldn't be sorted if localStorage wasn't available. This is now fixed: sorting works even though the sorting setting isn't retained. (`issue 944`_ and `pull request 945`_). Thanks, Abdeali Kothari. .. _issue 943: https://github.com/nedbat/coveragepy/issues/943 .. _issue 944: https://github.com/nedbat/coveragepy/issues/944 .. _pull request 945: https://github.com/nedbat/coveragepy/pull/945 .. _issue 948: https://github.com/nedbat/coveragepy/issues/948 .. _issue 949: https://github.com/nedbat/coveragepy/issues/949 .. _changes_503: ``` ### 5.0.3 ``` ---------------------------- - A performance improvement in 5.0.2 didn't work for test suites that changed directory before combining data, causing "Couldn't use data file: no such table: meta" errors (`issue 916`_). This is now fixed. - Coverage could fail to run your program with some form of "ModuleNotFound" or "ImportError" trying to import from the current directory. This would happen if coverage had been packaged into a zip file (for example, on Windows), or was found indirectly (for example, by pyenv-virtualenv). A number of different scenarios were described in `issue 862`_ which is now fixed. Huge thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and George-Cristian Bîrzan for protracted debugging sessions. - Added the "premain" debug option. - Added SQLite compile-time options to the "debug sys" output. .. _issue 862: https://github.com/nedbat/coveragepy/issues/862 .. _issue 916: https://github.com/nedbat/coveragepy/issues/916 .. _changes_502: ``` ### 5.0.2 ``` ---------------------------- - Programs that used multiprocessing and changed directories would fail under coverage. This is now fixed (`issue 890`_). A side effect is that debug information about the config files read now shows absolute paths to the files. - When running programs as modules (``coverage run -m``) with ``--source``, some measured modules were imported before coverage starts. This resulted in unwanted warnings ("Already imported a file that will be measured") and a reduction in coverage totals (`issue 909`_). This is now fixed. - If no data was collected, an exception about "No data to report" could happen instead of a 0% report being created (`issue 884`_). This is now fixed. - The handling of source files with non-encodable file names has changed. Previously, if a file name could not be encoded as UTF-8, an error occurred, as described in `issue 891`_. Now, those files will not be measured, since their data would not be recordable. - A new warning ("dynamic-conflict") is issued if two mechanisms are trying to change the dynamic context. Closes `issue 901`_. - ``coverage run --debug=sys`` would fail with an AttributeError. This is now fixed (`issue 907`_). .. _issue 884: https://github.com/nedbat/coveragepy/issues/884 .. _issue 890: https://github.com/nedbat/coveragepy/issues/890 .. _issue 891: https://github.com/nedbat/coveragepy/issues/891 .. _issue 901: https://github.com/nedbat/coveragepy/issues/901 .. _issue 907: https://github.com/nedbat/coveragepy/issues/907 .. _issue 909: https://github.com/nedbat/coveragepy/issues/909 .. _changes_501: ``` ### 5.0.1 ``` ---------------------------- - If a 4.x data file is the cause of a "file is not a database" error, then use a more specific error message, "Looks like a coverage 4.x data file, are you mixing versions of coverage?" Helps diagnose the problems described in `issue 886`_. - Measurement contexts and relative file names didn't work together, as reported in `issue 899`_ and `issue 900`_. This is now fixed, thanks to David Szotten. - When using ``coverage run --concurrency=multiprocessing``, all data files should be named with parallel-ready suffixes. 5.0 mistakenly named the main process' file with no suffix when using ``--append``. This is now fixed, closing `issue 880`_. - Fixed a problem on Windows when the current directory is changed to a different drive (`issue 895`_). Thanks, Olivier Grisel. - Updated Python 3.9 support to 3.9a2. .. _issue 880: https://github.com/nedbat/coveragepy/issues/880 .. _issue 886: https://github.com/nedbat/coveragepy/issues/886 .. _issue 895: https://github.com/nedbat/coveragepy/issues/895 .. _issue 899: https://github.com/nedbat/coveragepy/issues/899 .. _issue 900: https://github.com/nedbat/coveragepy/issues/900 .. _changes_50: ``` ### 5.0 ``` -------------------------- Nothing new beyond 5.0b2. .. _changes_50b2: ``` ### 5.0b2 ``` ---------------------------- - An experimental ``[run] relative_files`` setting tells coverage to store relative file names in the data file. This makes it easier to run tests in one (or many) environments, and then report in another. It has not had much real-world testing, so it may change in incompatible ways in the future. - When constructing a :class:`coverage.Coverage` object, `data_file` can be specified as None to prevent writing any data file at all. In previous versions, an explicit `data_file=None` argument would use the default of ".coverage". Fixes `issue 871`_. - Python files run with ``-m`` now have ``__spec__`` defined properly. This fixes `issue 745`_ (about not being able to run unittest tests that spawn subprocesses), and `issue 838`_, which described the problem directly. - The ``[paths]`` configuration section is now ordered. If you specify more than one list of patterns, the first one that matches will be used. Fixes `issue 649`_. - The :func:`.coverage.numbits.register_sqlite_functions` function now also registers `numbits_to_nums` for use in SQLite queries. Thanks, Simon Willison. - Python 3.9a1 is supported. - Coverage.py has a mascot: :ref:`Sleepy Snake <sleepy>`. .. _issue 649: https://github.com/nedbat/coveragepy/issues/649 .. _issue 745: https://github.com/nedbat/coveragepy/issues/745 .. _issue 838: https://github.com/nedbat/coveragepy/issues/838 .. _issue 871: https://github.com/nedbat/coveragepy/issues/871 .. _changes_50b1: ``` ### 5.0b1 ``` ---------------------------- - The HTML and textual reports now have a ``--skip-empty`` option that skips files with no statements, notably ``__init__.py`` files. Thanks, Reya B. - Configuration can now be read from `TOML`_ files. This requires installing coverage.py with the ``[toml]`` extra. The standard "pyproject.toml" file will be read automatically if no other configuration file is found, with settings in the ``[tool.coverage.]`` namespace. Thanks to Frazer McLean for implementation and persistence. Finishes `issue 664`_. - The ``[run] note`` setting has been deprecated. Using it will result in a warning, and the note will not be written to the data file. The corresponding :class:`.CoverageData` methods have been removed. - The HTML report has been reimplemented (no more table around the source code). This allowed for a better presentation of the context information, hopefully resolving `issue 855`_. - Added sqlite3 module version information to ``coverage debug sys`` output. - Asking the HTML report to show contexts (``[html] show_contexts=True`` or ``coverage html --show-contexts``) will issue a warning if there were no contexts measured (`issue 851`_). .. _TOML: https://github.com/toml-lang/tomlreadme .. _issue 664: https://github.com/nedbat/coveragepy/issues/664 .. _issue 851: https://github.com/nedbat/coveragepy/issues/851 .. _issue 855: https://github.com/nedbat/coveragepy/issues/855 .. _changes_50a8: ``` ### 5.0a8 ``` ---------------------------- - The :class:`.CoverageData` API has changed how queries are limited to specific contexts. Now you use :meth:`.CoverageData.set_query_context` to set a single exact-match string, or :meth:`.CoverageData.set_query_contexts` to set a list of regular expressions to match contexts. This changes the command-line ``--contexts`` option to use regular expressions instead of filename-style wildcards. .. _changes_50a7: ``` ### 5.0a7 ``` ---------------------------- - Data can now be "reported" in JSON format, for programmatic use, as requested in `issue 720`_. The new ``coverage json`` command writes raw and summarized data to a JSON file. Thanks, Matt Bachmann. - Dynamic contexts are now supported in the Python tracer, which is important for PyPy users. Closes `issue 846`_. - The compact line number representation introduced in 5.0a6 is called a "numbits." The :mod:`coverage.numbits` module provides functions for working with them. - The reporting methods used to permanently apply their arguments to the configuration of the Coverage object. Now they no longer do. The arguments affect the operation of the method, but do not persist. - A class named "test_something" no longer confuses the ``test_function`` dynamic context setting. Fixes `issue 829`_. - Fixed an unusual tokenizing issue with backslashes in comments. Fixes `issue 822`_. - ``debug=plugin`` didn't properly support configuration or dynamic context plugins, but now it does, closing `issue 834`_. .. _issue 720: https://github.com/nedbat/coveragepy/issues/720 .. _issue 822: https://github.com/nedbat/coveragepy/issues/822 .. _issue 834: https://github.com/nedbat/coveragepy/issues/834 .. _issue 829: https://github.com/nedbat/coveragepy/issues/829 .. _issue 846: https://github.com/nedbat/coveragepy/issues/846 .. _changes_50a6: ``` ### 5.0a6 ``` ---------------------------- - Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas for the contribution. - The ``--contexts`` option is available on the ``report`` and ``html`` commands. It's a comma-separated list of shell-style wildcards, selecting the contexts to report on. Only contexts matching one of the wildcards will be included in the report. - The ``--show-contexts`` option for the ``html`` command adds context information to each covered line. Hovering over the "ctx" marker at the end of the line reveals a list of the contexts that covered the line. - Database changes: - Line numbers are now stored in a much more compact way. For each file and context, a single binary string is stored with a bit per line number. This greatly improves memory use, but makes ad-hoc use difficult. - Dynamic contexts with no data are no longer written to the database. - SQLite data storage is now faster. There's no longer a reason to keep the JSON data file code, so it has been removed. - Changes to the :class:`.CoverageData` interface: - The new :meth:`.CoverageData.dumps` method serializes the data to a string, and a corresponding :meth:`.CoverageData.loads` method reconstitutes this data. The format of the data string is subject to change at any time, and so should only be used between two installations of the same version of coverage.py. - The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new argument, `no_disk` (default: False). Setting it to True prevents writing any data to the disk. This is useful for transient data objects. - Added the classmethod :meth:`.Coverage.current` to get the latest started Coverage instance. - Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes `issue 828`_. - Error handling during reporting has changed slightly. All reporting methods now behave the same. The ``--ignore-errors`` option keeps errors from stopping the reporting, but files that couldn't parse as Python will always be reported as warnings. As with other warnings, you can suppress them with the ``[run] disable_warnings`` configuration setting. - Coverage.py no longer fails if the user program deletes its current directory. Fixes `issue 806`_. Thanks, Dan Hemberger. - The scrollbar markers in the HTML report now accurately show the highlighted lines, regardless of what categories of line are highlighted. - The hack to accommodate ShiningPanda_ looking for an obsolete internal data file has been removed, since ShiningPanda 0.22 fixed it four years ago. - The deprecated `Reporter.file_reporters` property has been removed. .. _ShiningPanda: https://wiki.jenkins.io/display/JENKINS/ShiningPanda+Plugin .. _issue 806: https://github.com/nedbat/coveragepy/pull/806 .. _issue 828: https://github.com/nedbat/coveragepy/issues/828 .. _changes_50a5: ``` ### 5.0a5 ``` ---------------------------- - Drop support for Python 3.4 - Dynamic contexts can now be set two new ways, both thanks to Justas Sadzevičius. - A plugin can implement a ``dynamic_context`` method to check frames for whether a new context should be started. See :ref:`dynamic_context_plugins` for more details. - Another tool (such as a test runner) can use the new :meth:`.Coverage.switch_context` method to explicitly change the context. - The ``dynamic_context = test_function`` setting now works with Python 2 old-style classes, though it only reports the method name, not the class it was defined on. Closes `issue 797`_. - ``fail_under`` values more than 100 are reported as errors. Thanks to Mike Fiedler for closing `issue 746`_. - The "missing" values in the text output are now sorted by line number, so that missing branches are reported near the other lines they affect. The values used to show all missing lines, and then all missing branches. - Access to the SQLite database used for data storage is now thread-safe. Thanks, Stephan Richter. This closes `issue 702`_. - Combining data stored in SQLite is now about twice as fast, fixing `issue 761`_. Thanks, Stephan Richter. - The ``filename`` attribute on :class:`.CoverageData` objects has been made private. You can use the ``data_filename`` method to get the actual file name being used to store data, and the ``base_filename`` method to get the original filename before parallelizing suffixes were added. This is part of fixing `issue 708`_. - Line numbers in the HTML report now align properly with source lines, even when Chrome's minimum font size is set, fixing `issue 748`_. Thanks Wen Ye. .. _issue 702: https://github.com/nedbat/coveragepy/issues/702 .. _issue 708: https://github.com/nedbat/coveragepy/issues/708 .. _issue 746: https://github.com/nedbat/coveragepy/issues/746 .. _issue 748: https://github.com/nedbat/coveragepy/issues/748 .. _issue 761: https://github.com/nedbat/coveragepy/issues/761 .. _issue 797: https://github.com/nedbat/coveragepy/issues/797 .. _changes_50a4: ``` ### 5.0a4 ``` ---------------------------- - You can specify the command line to run your program with the ``[run] command_line`` configuration setting, as requested in `issue 695`_. - Coverage will create directories as needed for the data file if they don't exist, closing `issue 721`_. - The ``coverage run`` command has always adjusted the first entry in sys.path, to properly emulate how Python runs your program. Now this adjustment is skipped if sys.path[0] is already different than Python's default. This fixes `issue 715`_. - Improvements to context support: - The "no such table: meta" error is fixed.: `issue 716`_. - Combining data files is now much faster. - Python 3.8 (as of today!) passes all tests. .. _issue 695: https://github.com/nedbat/coveragepy/issues/695 .. _issue 715: https://github.com/nedbat/coveragepy/issues/715 .. _issue 716: https://github.com/nedbat/coveragepy/issues/716 .. _issue 721: https://github.com/nedbat/coveragepy/issues/721 .. _changes_50a3: ``` ### 5.0a3 ``` ---------------------------- - Context support: static contexts let you specify a label for a coverage run, which is recorded in the data, and retained when you combine files. See :ref:`contexts` for more information. - Dynamic contexts: specifying ``[run] dynamic_context = test_function`` in the config file will record the test function name as a dynamic context during execution. This is the core of "Who Tests What" (`issue 170`_). Things to note: - There is no reporting support yet. Use SQLite to query the .coverage file for information. Ideas are welcome about how reporting could be extended to use this data. - There's a noticeable slow-down before any test is run. - Data files will now be roughly N times larger, where N is the number of tests you have. Combining data files is therefore also N times slower. - No other values for ``dynamic_context`` are recognized yet. Let me know what else would be useful. I'd like to use a pytest plugin to get better information directly from pytest, for example. .. _issue 170: https://github.com/nedbat/coveragepy/issues/170 - Environment variable substitution in configuration files now supports two syntaxes for controlling the behavior of undefined variables: if ``VARNAME`` is not defined, ``${VARNAME?}`` will raise an error, and ``${VARNAME-default value}`` will use "default value". - Partial support for Python 3.8, which has not yet released an alpha. Fixes `issue 707`_ and `issue 714`_. .. _issue 707: https://github.com/nedbat/coveragepy/issues/707 .. _issue 714: https://github.com/nedbat/coveragepy/issues/714 .. _changes_50a2: ``` ### 5.0a2 ``` ---------------------------- - Coverage's data storage has changed. In version 4.x, .coverage files were basically JSON. Now, they are SQLite databases. This means the data file can be created earlier than it used to. A large amount of code was refactored to support this change. - Because the data file is created differently than previous releases, you may need ``parallel=true`` where you didn't before. - The old data format is still available (for now) by setting the environment variable COVERAGE_STORAGE=json. Please tell me if you think you need to keep the JSON format. - The database schema is guaranteed to change in the future, to support new features. I'm looking for opinions about making the schema part of the public API to coverage.py or not. - Development moved from `Bitbucket`_ to `GitHub`_. - HTML files no longer have trailing and extra whitespace. - The sort order in the HTML report is stored in local storage rather than cookies, closing `issue 611`_. Thanks, Federico Bond. - pickle2json, for converting v3 data files to v4 data files, has been removed. .. _Bitbucket: https://bitbucket.org .. _GitHub: https://github.com/nedbat/coveragepy .. _issue 611: https://github.com/nedbat/coveragepy/issues/611 .. _changes_50a1: ``` ### 5.0a1 ``` ---------------------------- - Coverage.py no longer supports Python 2.6 or 3.3. - The location of the configuration file can now be specified with a ``COVERAGE_RCFILE`` environment variable, as requested in `issue 650`_. - Namespace packages are supported on Python 3.7, where they used to cause TypeErrors about path being None. Fixes `issue 700`_. - A new warning (``already-imported``) is issued if measurable files have already been imported before coverage.py started measurement. See :ref:`cmd_warnings` for more information. - Running coverage many times for small runs in a single process should be faster, closing `issue 625`_. Thanks, David MacIver. - Large HTML report pages load faster. Thanks, Pankaj Pandey. .. _issue 625: https://github.com/nedbat/coveragepy/issues/625 .. _issue 650: https://github.com/nedbat/coveragepy/issues/650 .. _issue 700: https://github.com/nedbat/coveragepy/issues/700 .. _changes_454: ``` ### 4.5.4 ``` ---------------------------- - Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes `issue 828`_. .. _issue 828: https://github.com/nedbat/coveragepy/issues/828 .. _changes_453: ``` ### 4.5.3 ``` ---------------------------- - Only packaging metadata changes. .. _changes_452: ```
Links - PyPI: https://pypi.org/project/coverage - Changelog: https://pyup.io/changelogs/coverage/ - Repo: https://github.com/nedbat/coveragepy

Update Sphinx from 1.8.4 to 3.2.1.

Changelog ### 3.2.1 ``` ===================================== Features added -------------- * 8095: napoleon: Add :confval:`napoleon_preprocess_types` to enable the type preprocessor for numpy style docstrings * 8114: C and C++, parse function attributes after parameters and qualifiers. Bugs fixed ---------- * 8074: napoleon: Crashes during processing C-ext module * 8088: napoleon: "Inline literal start-string without end-string" warning in Numpy style Parameters section * 8084: autodoc: KeyError is raised on documenting an attribute of the broken class * 8091: autodoc: AttributeError is raised on documenting an attribute on Python 3.5.2 * 8099: autodoc: NameError is raised when target code uses ``TYPE_CHECKING`` * C++, fix parsing of template template paramters, broken by the fix of 7944 ``` ### 3.2.0 ``` ===================================== Deprecated ---------- * ``sphinx.ext.autodoc.members_set_option()`` * ``sphinx.ext.autodoc.merge_special_members_option()`` * ``sphinx.writers.texinfo.TexinfoWriter.desc`` * C, parsing of pre-v3 style type directives and roles, along with the options :confval:`c_allow_pre_v3` and :confval:`c_warn_on_allowed_pre_v3`. Features added -------------- * 2076: autodoc: Allow overriding of exclude-members in skip-member function * 8034: autodoc: ``:private-member:`` can take an explicit list of member names to be documented * 2024: autosummary: Add :confval:`autosummary_filename_map` to avoid conflict of filenames between two object with different case * 8011: autosummary: Support instance attributes as a target of autosummary directive * 7849: html: Add :confval:`html_codeblock_linenos_style` to change the style of line numbers for code-blocks * 7853: C and C++, support parameterized GNU style attributes. * 7888: napoleon: Add aliases Warn and Raise. * 7690: napoleon: parse type strings and make them hyperlinks as possible. The conversion rule can be updated via :confval:`napoleon_type_aliases` * 8049: napoleon: Create a hyperlink for each the type of parameter when :confval:`napoleon_use_params` is False * C, added :rst:dir:`c:alias` directive for inserting copies of existing declarations. * 7745: html: inventory is broken if the docname contains a space * 7991: html search: Allow searching for numbers * 7902: html theme: Add a new option :confval:`globaltoc_maxdepth` to control the behavior of globaltoc in sidebar * 7840: i18n: Optimize the dependencies check on bootstrap * 7768: i18n: :confval:`figure_language_filename` supports ``docpath`` token * 5208: linkcheck: Support checks for local links * 5090: setuptools: Link verbosity to distutils' -v and -q option * 6698: doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:`` options to doctest, testcode and testoutput directives * 7052: add ``:noindexentry:`` to the Python, C, C++, and Javascript domains. Update the documentation to better reflect the relationship between this option and the ``:noindex:`` option. * 7899: C, add possibility of parsing of some pre-v3 style type directives and roles and try to convert them to equivalent v3 directives/roles. Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this. The warnings printed from this functionality can be suppressed by setting :confval:`c_warn_on_allowed_pre_v3`` to ``True``. The functionality is immediately deprecated. * 7999: C, add support for named variadic macro arguments. * 8071: Allow to suppress "self referenced toctrees" warning Bugs fixed ---------- * 7886: autodoc: TypeError is raised on mocking generic-typed classes * 7935: autodoc: function signature is not shown when the function has a parameter having ``inspect._empty`` as its default value * 7901: autodoc: type annotations for overloaded functions are not resolved * 904: autodoc: An instance attribute cause a crash of autofunction directive * 1362: autodoc: ``private-members`` option does not work for class attributes * 7983: autodoc: Generator type annotation is wrongly rendered in py36 * 8030: autodoc: An uninitialized annotated instance variable is not documented when ``:inherited-members:`` option given * 8032: autodoc: A type hint for the instance variable defined at parent class is not shown in the document of the derived class * 8041: autodoc: An annotated instance variable on super class is not documented when derived class has other annotated instance variables * 7839: autosummary: cannot handle umlauts in function names * 7865: autosummary: Failed to extract summary line when abbreviations found * 7866: autosummary: Failed to extract correct summary line when docstring contains a hyperlink target * 7469: autosummary: "Module attributes" header is not translatable * 7940: apidoc: An extra newline is generated at the end of the rst file if a module has submodules * 4258: napoleon: decorated special methods are not shown * 7799: napoleon: parameters are not escaped for combined params in numpydoc * 7780: napoleon: multiple paramaters declaration in numpydoc was wrongly recognized when napoleon_use_params=True * 7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links * 7846: html theme: XML-invalid files were generated * 7894: gettext: Wrong source info is shown when using rst_epilog * 7691: linkcheck: HEAD requests are not used for checking * 4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation * 7928: py domain: failed to resolve a type annotation for the attribute * 8008: py domain: failed to parse a type annotation containing ellipsis * 7994: std domain: option directive does not generate old node_id compatible with 2.x or older * 7968: i18n: The content of ``math`` directive is interpreted as reST on translation * 7768: i18n: The ``root`` element for :confval:`figure_language_filename` is not a path that user specifies in the document * 7993: texinfo: TypeError is raised for nested object descriptions * 7993: texinfo: a warning not supporting desc_signature_line node is shown * 7869: :rst:role:`abbr` role without an explanation will show the explanation from the previous abbr role * 8048: graphviz: graphviz.css was copied on building non-HTML document * C and C++, removed ``noindex`` directive option as it did nothing. * 7619: Duplicated node IDs are generated if node has multiple IDs * 2050: Symbols sections are appeared twice in the index page * 8017: Fix circular import in sphinx.addnodes * 7986: CSS: make "highlight" selector more robust * 7944: C++, parse non-type template parameters starting with a dependent qualified name. * C, don't deepcopy the entire symbol table and make a mess every time an enumerator is handled. ``` ### 3.1.2 ``` ===================================== Incompatible changes -------------------- * 7650: autodoc: the signature of base function will be shown for decorated functions, not a signature of decorator Bugs fixed ---------- * 7844: autodoc: Failed to detect module when relative module name given * 7856: autodoc: AttributeError is raised when non-class object is given to the autoclass directive * 7850: autodoc: KeyError is raised for invalid mark up when autodoc_typehints is 'description' * 7812: autodoc: crashed if the target name matches to both an attribute and module that are same name * 7650: autodoc: function signature becomes ``(*args, **kwargs)`` if the function is decorated by generic decorator * 7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name * 7806: viewcode: Failed to resolve viewcode references on 3rd party builders * 7838: html theme: List items have extra vertical space * 7878: html theme: Undesired interaction between "overflow" and "float" ``` ### 3.1.1 ``` ===================================== Incompatible changes -------------------- * 7808: napoleon: a type for attribute are represented as typed field Features added -------------- * 7807: autodoc: Show detailed warning when type_comment is mismatched with its signature Bugs fixed ---------- * 7808: autodoc: Warnings raised on variable and attribute type annotations * 7802: autodoc: EOFError is raised on parallel build * 7821: autodoc: TypeError is raised for overloaded C-ext function * 7805: autodoc: an object which descriptors returns is unexpectedly documented * 7807: autodoc: wrong signature is shown for the function using contextmanager * 7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name * 7808: napoleon: Warnings raised on variable and attribute type annotations * 7811: sphinx.util.inspect causes circular import problem ``` ### 3.1.0 ``` ===================================== Dependencies ------------ * 7746: mathjax: Update to 2.7.5 Incompatible changes -------------------- * 7477: imgconverter: Invoke "magick convert" command by default on Windows Deprecated ---------- * The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has been changed to Sphinx object * ``sphinx.ext.autosummary.generate.AutosummaryRenderer`` takes an object type as an argument * The ``ignore`` argument of ``sphinx.ext.autodoc.Documenter.get_doc()`` * The ``template_dir`` argument of ``sphinx.ext.autosummary.generate. AutosummaryRenderer`` * The ``module`` argument of ``sphinx.ext.autosummary.generate. find_autosummary_in_docstring()`` * The ``builder`` argument of ``sphinx.ext.autosummary.generate. generate_autosummary_docs()`` * The ``template_dir`` argument of ``sphinx.ext.autosummary.generate. generate_autosummary_docs()`` * The ``ignore`` argument of ``sphinx.util.docstring.prepare_docstring()`` * ``sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()`` * ``sphinx.util.rpartition()`` Features added -------------- * LaTeX: Make the ``toplevel_sectioning`` setting optional in LaTeX theme * LaTeX: Allow to override papersize and pointsize from LaTeX themes * LaTeX: Add :confval:`latex_theme_options` to override theme options * 7410: Allow to suppress "circular toctree references detected" warnings using :confval:`suppress_warnings` * C, added scope control directives, :rst:dir:`c:namespace`, :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`. * 2044: autodoc: Suppress default value for instance attributes * 7473: autodoc: consider a member public if docstring contains ``:meta public:`` in info-field-list * 7487: autodoc: Allow to generate docs for singledispatch functions by py:autofunction * 7143: autodoc: Support final classes and methods * 7384: autodoc: Support signatures defined by ``__new__()``, metaclasses and builtin base classes * 2106: autodoc: Support multiple signatures on docstring * 4422: autodoc: Support GenericAlias in Python 3.7 or above * 3610: autodoc: Support overloaded functions * 7722: autodoc: Support TypeVar * 7466: autosummary: headings in generated documents are not translated * 7490: autosummary: Add ``:caption:`` option to autosummary directive to set a caption to the toctree * 7469: autosummary: Support module attributes * 248, 6040: autosummary: Add ``:recursive:`` option to autosummary directive to generate stub files recursively * 4030: autosummary: Add :confval:`autosummary_context` to add template variables for custom templates * 7530: html: Support nested <kbd> elements * 7481: html theme: Add right margin to footnote/citation labels * 7482, 7717: html theme: CSS spacing for code blocks with captions and line numbers * 7443: html theme: Add new options :confval:`globaltoc_collapse` and :confval:`globaltoc_includehidden` to control the behavior of globaltoc in sidebar * 7484: html theme: Avoid clashes between sidebar and other blocks * 7476: html theme: Relbar breadcrumb should contain current page * 7506: html theme: A canonical URL is not escaped * 7533: html theme: Avoid whitespace at the beginning of genindex.html * 7541: html theme: Add a "clearer" at the end of the "body" * 7542: html theme: Make admonition/topic/sidebar scrollable * 7543: html theme: Add top and bottom margins to tables * 7695: html theme: Add viewport meta tag for basic theme * 7721: html theme: classic: default codetextcolor/codebgcolor doesn't override Pygments * C and C++: allow semicolon in the end of declarations. * C++, parse parameterized noexcept specifiers. * 7294: C++, parse expressions with user-defined literals. * C++, parse trailing return types. * 7143: py domain: Add ``:final:`` option to :rst:dir:`py:class:`, :rst:dir:`py:exception:` and :rst:dir:`py:method:` directives * 7596: py domain: Change a type annotation for variables to a hyperlink * 7770: std domain: :rst:dir:`option` directive support arguments in the form of ``foo[=bar]`` * 7582: napoleon: a type for attribute are represented like type annotation * 7734: napoleon: overescaped trailing underscore on attribute * 7247: linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP headers for specific host * 7792: setuptools: Support ``--verbosity`` option * 7683: Add ``allowed_exceptions`` parameter to ``Sphinx.emit()`` to allow handlers to raise specified exceptions * 7295: C++, parse (trailing) requires clauses. Bugs fixed ---------- * 6703: autodoc: incremental build does not work for imported objects * 7564: autodoc: annotations not to be shown for descriptors * 6588: autodoc: Decorated inherited method has no documentation * 7469: autodoc: The change of autodoc-process-docstring for variables is cached unexpectedly * 7559: autodoc: misdetects a sync function is async * 6857: autodoc: failed to detect a classmethod on Enum class * 7562: autodoc: a typehint contains spaces is wrongly rendered under autodoc_typehints='description' mode * 7551: autodoc: failed to import nested class * 7362: autodoc: does not render correct signatures for built-in functions * 7654: autodoc: ``Optional[Union[foo, bar]]`` is presented as ``Union[foo, bar, None]`` * 7629: autodoc: autofunction emits an unfriendly warning if an invalid object specified * 7650: autodoc: undecorated signature is shown for decorated functions * 7676: autodoc: typo in the default value of autodoc_member_order * 7676: autodoc: wrong value for :member-order: option is ignored silently * 7676: autodoc: member-order="bysource" does not work for C module * 3673: autodoc: member-order="bysource" does not work for a module having __all__ * 7668: autodoc: wrong retann value is passed to a handler of autodoc-proccess-signature * 7711: autodoc: fails with ValueError when processing numpy objects * 7791: autodoc: TypeError is raised on documenting singledispatch function * 7551: autosummary: a nested class is indexed as non-nested class * 7661: autosummary: autosummary directive emits warnings twices if failed to import the target module * 7685: autosummary: The template variable "members" contains imported members even if :confval:`autossummary_imported_members` is False * 7671: autosummary: The location of import failure warning is missing * 7535: sphinx-autogen: crashes when custom template uses inheritance * 7536: sphinx-autogen: crashes when template uses i18n feature * 7781: sphinx-build: Wrong error message when outdir is not directory * 7653: sphinx-quickstart: Fix multiple directory creation for nested relpath * 2785: html: Bad alignment of equation links * 7718: html theme: some themes does not respect background color of Pygments style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional) * 7544: html theme: inconsistent padding in admonitions * 7581: napoleon: bad parsing of inline code in attribute docstrings * 7628: imgconverter: runs imagemagick once unnecessary for builders not supporting images * 7610: incorrectly renders consecutive backslashes for docutils-0.16 * 7646: handle errors on event handlers * 4187: LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents * 7701: LaTeX: Anonymous indirect hyperlink target causes duplicated labels * 7723: LaTeX: pdflatex crashed when URL contains a single quote * 7756: py domain: The default value for positional only argument is not shown * 7760: coverage: Add :confval:`coverage_show_missing_items` to show coverage result to console * C++, fix rendering and xrefs in nested names explicitly starting in global scope, e.g., ``::A::B``. * C, fix rendering and xrefs in nested names explicitly starting in global scope, e.g., ``.A.B``. * 7763: C and C++, don't crash during display stringification of unary expressions and fold expressions. ``` ### 3.0.4 ``` ===================================== Bugs fixed ---------- * 7567: autodoc: parametrized types are shown twice for generic types * 7637: autodoc: system defined TypeVars are shown in Python 3.9 * 7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons * 7611: md5 fails when OpenSSL FIPS is enabled * 7626: release package does not contain ``CODE_OF_CONDUCT`` ``` ### 3.0.3 ``` ===================================== Features
pyup-bot commented 3 years ago

Closing this in favor of #490