Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Update #1

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Initial Update #1

wants to merge 7 commits into from

Conversation

pyup-bot
Copy link

This is my first visit to this fine repo so I have bundled all updates in a single pull request to make things easier for you to merge.

Close this pull request and delete the branch if you want me to start with single pull requests right away

Here's the executive summary:

Updates

Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need.

pip 8.1.2 » 9.0.1 PyPI | Changelog | Homepage
flake8 2.6.0 » 3.3.0 PyPI | Changelog | Repo
tox 2.3.1 » 2.7.0 PyPI | Changelog | Docs
coverage 4.1 » 4.4.1 PyPI | Changelog | Docs
Sphinx 1.4.8 » 1.6.2 PyPI | Changelog | Homepage
cryptography 1.7 » 1.9 PyPI | Changelog | Repo
PyYAML 3.11 » 3.12 PyPI | Changelog | Homepage

Changelogs

pip 8.1.2 -> 9.0.1

9.0.1

==================

  • Correct the deprecation message when not specifying a --format so that it
    uses the correct setting name (format) rather than the incorrect one
    (list_format). (4058)
  • Fix pip check to check all available distributions and not just the
    local ones. (4083)
  • Fix a crash on non ASCII characters from lsb_release. (4062)
  • Fix an SyntaxError in an unused module of a vendored dependency. (4059)
  • Fix UNC paths on Windows. (4064)

9.0.0

==================

  • BACKWARD INCOMPATIBLE Remove the attempted autodetection of requirement
    names from URLs, URLs must include a name via egg=.
  • DEPRECATION pip install --egg have been deprecated and will be
    removed in the future. This "feature" has a long list of drawbacks which
    break nearly all of pip's other features in subtle and hard-to-diagnose
    ways.
  • DEPRECATION --default-vcs option. (4052)
  • WARNING pip 9 cache can break forward compatibility with previous pip
    versions if your package repository allows chunked responses. (4078)
  • Add a pip check command to check installed packages dependencies. (3750)
  • Add option allowing user to abort pip operation if file/directory exists
  • Add Appveyor CI
  • Uninstall existing packages when performing an editable installation of
    the same packages. (1548)
  • pip show is less verbose by default. --verbose prints multiline
    fields. (3858)
  • Add optional column formatting to pip list. (3651)
  • Add --not-required option to pip list, which lists packages that are
    not dependencies of other packages.
  • Fix builds on systems with symlinked /tmp directory for custom
    builds such as numpy. (3701)
  • Fix regression in pip freeze: when there is more than one git remote,
    priority is given to the remote named origin. (3708, 3616).
  • Fix crash when calling pip freeze with invalid requirement installed.
    (3704, 3681)
  • Allow multiple --requirement files in pip freeze. (3703)
  • Implementation of pep-503 data-requires-python. When this field is
    present for a release link, pip will ignore the download when
    installing to a Python version that doesn't satisfy the requirement.
  • pip wheel now works on editable packages too (it was only working on
    editable dependencies before); this allows running pip wheel on the result
    of pip freeze in presence of editable requirements. (3695, 3291)
  • Load credentials from .netrc files. (3715, 3569)
  • Add --platform, --python-version, --implementation and --abi
    parameters to pip download. These allow utilities and advanced users to
    gather distributions for interpreters other than the one pip is being run on.
    (3760)
  • Skip scanning virtual environments, even when venv/bin/python is a dangling
    symlink.
  • Added pip completion support for the fish shell.
  • Fix problems on Windows on Python 2 when username or hostname contains
    non-ASCII characters. (3463, 3970, 4000)
  • Use git fetch --tags to fetch tags in addition to everything else that
    is normally fetched; this is necessary in case a git requirement url
    points to a tag or commit that is not on a branch. (3791)
  • Normalize package names before using in pip show (3976)
  • Raise when Requires-Python do not match the running version and add
    --ignore-requires-python option as escape hatch. (3846)
  • Report the correct installed version when performing an upgrade in some
    corner cases. (2382
  • Add -i shorthand for --index flag in pip search.
  • Do not optionally load C dependencies in requests. (1840, 2930, 3024)
  • Strip authentication from SVN url prior to passing it to svn.
    (3697, 3209)
  • Also install in platlib with --target option. (3694, 3682)
  • Restore the ability to use inline comments in requirements files passed to
    pip freeze. (3680)

flake8 2.6.0 -> 3.3.0

3.3.0


You can view the 3.3.0 milestone_ on GitLab for more details.

  • Add support for Python 3.6 (via dependencies). Note Flake8 does not
    guarantee that all plugins will support Python 3.6.
  • Added unique error codes for all missing PyFlakes messages. (14 new
    codes, see "Error / Violation Codes")
  • Dramatically improve the performance of Flake8. (See also GitLab!156_)
  • Display the local file path instead of the temporary file path when
    using the git hook. (See also GitLab244_)
  • Add methods to Report class that will be called when Flake8 starts and
    finishes processing a file. (See also GitLab251_)
  • Fix problem where hooks should only check *.py files. (See also
    GitLab268_)
  • Fix handling of SyntaxErrors that do not include physical line information.
    (See also GitLab279_)
  • Update upper bound on PyFlakes to allow for PyFlakes 1.5.0. (See also
    GitLab290_)
  • Update setuptools integration to less eagerly deduplicate packages.
    (See also GitLab295_)
  • Force flake8 --version to be repeatable between invocations. (See also
    GitLab297_)

.. all links
.. _3.3.0 milestone:
https://gitlab.com/pycqa/flake8/milestones/16

.. issue links
.. _GitLab244:
https://gitlab.com/pycqa/flake8/issues/244
.. _GitLab251:
https://gitlab.com/pycqa/flake8/issues/251
.. _GitLab268:
https://gitlab.com/pycqa/flake8/issues/268
.. _GitLab279:
https://gitlab.com/pycqa/flake8/issues/279
.. _GitLab290:
https://gitlab.com/pycqa/flake8/issues/290
.. _GitLab295:
https://gitlab.com/pycqa/flake8/issues/295
.. _GitLab297:
https://gitlab.com/pycqa/flake8/issues/297

.. merge request links
.. _GitLab!156:
https://gitlab.com/pycqa/flake8/merge_requests/156

3.2.1


You can view the 3.2.1 milestone_ on GitLab for more details.

  • Fix subtle bug when deciding whether to report an on-by-default's violation
    (See also GitLab257_)
  • Fix another bug around SyntaxErrors not being reported at the right column
    and row (See also GitLab259_ and GitLab237_ for a related, previously
    fixed bug)
  • Fix regression from 2.x where we run checks against explicitly provided
    files, even if they don't match the filename patterns. (See also
    GitLab266_)

.. links
.. _3.2.1 milestone:
https://gitlab.com/pycqa/flake8/milestones/15
.. _GitLab237:
https://gitlab.com/pycqa/flake8/issues/237
.. _GitLab257:
https://gitlab.com/pycqa/flake8/issues/257
.. _GitLab259:
https://gitlab.com/pycqa/flake8/issues/259
.. _GitLab266:
https://gitlab.com/pycqa/flake8/issues/266

3.2.0


You can view the 3.2.0 milestone_ on GitLab for more details.

  • Allow for pycodestyle 2.2.0 which fixes a bug in E305 (See also
    GitLab256_)

.. links
.. _3.2.0 milestone:
https://gitlab.com/pycqa/flake8/milestones/14
.. _GitLab256:
https://gitlab.com/pycqa/flake8/issues/256

3.1.1


You can view the 3.1.1 milestone_ on GitLab for more details.

  • Do not attempt to install/distribute a man file with the Python package;
    leave this for others to do. (See also GitLab254_)
  • Fix packaging bug where wheel version constraints specified in setup.cfg did
    not match the constraints in setup.py. (See also GitLab255_)

.. links
.. _3.1.1 milestone:
https://gitlab.com/pycqa/flake8/milestones/13
.. _GitLab254:
https://gitlab.com/pycqa/flake8/issues/254
.. _GitLab255:
https://gitlab.com/pycqa/flake8/issues/255

3.1.0


You can view the 3.1.0 milestone_ on GitLab for more details.

  • Add --bug-report flag to make issue reporters' lives easier.
  • Collect configuration files from the current directory when using our Git
    hook. (See also GitLab210, GitLab218, GitLab223_)
  • Avoid unhandled exceptions when dealing with SyntaxErrors. (See also
    GitLab214, GitLab238)
  • Exit early if the value for --diff is empty. (See also GitLab226_)
  • Handle empty --stdin-display-name values. (See also GitLab235_)
  • Properly report the column number of Syntax Errors. We were assuming that
    all reports of column numbers were 0-indexed, however, SyntaxErrors report
    the column number as 1-indexed. This caused us to report a column number
    that was 1 past the actual position. Further, when combined with
    SyntaxErrors that occur at a newline, this caused the position to be
    visually off by two. (See also GitLab237_)
  • Fix the behaviour of --enable-extensions. Previously, items specified
    here were still ignored due to the fact that the off-by-default extension
    codes were being left in the ignore list. (See also GitLab239_)
  • Fix problems around --select and --ignore behaviour that prevented
    codes that were neither explicitly selected nor explicitly ignored from
    being reported. (See also GitLab242_)
  • Truly be quiet when the user specifies -q one or more times. Previously,
    we were showing the if the user specified -q and --show-source. We
    have fixed this bug. (See also GitLab245_)
  • Add new File Processor attribute, previous_unindented_logical_line to
    accommodate pycodestyle 2.1.0. (See also GitLab246_)
  • When something goes wrong, exit non-zero. (See also GitLab248,
    GitLab209
    )
  • Add --tee as an option to allow use of --output-file and printing to
    standard out.
  • Allow the git plugin to actually be lazy when collecting files.
  • Allow for pycodestyle 2.1 series and pyflakes 1.3 series.

.. links
.. _3.1.0 milestone:
https://gitlab.com/pycqa/flake8/milestones/12
.. _GitLab209:
https://gitlab.com/pycqa/flake8/issues/209
.. _GitLab210:
https://gitlab.com/pycqa/flake8/issues/210
.. _GitLab214:
https://gitlab.com/pycqa/flake8/issues/214
.. _GitLab218:
https://gitlab.com/pycqa/flake8/issues/218
.. _GitLab223:
https://gitlab.com/pycqa/flake8/issues/223
.. _GitLab226:
https://gitlab.com/pycqa/flake8/issues/226
.. _GitLab235:
https://gitlab.com/pycqa/flake8/issues/235
.. _GitLab237:
https://gitlab.com/pycqa/flake8/issues/237
.. _GitLab238:
https://gitlab.com/pycqa/flake8/issues/238
.. _GitLab239:
https://gitlab.com/pycqa/flake8/issues/239
.. _GitLab242:
https://gitlab.com/pycqa/flake8/issues/242
.. _GitLab245:
https://gitlab.com/pycqa/flake8/issues/245
.. _GitLab246:
https://gitlab.com/pycqa/flake8/issues/246
.. _GitLab248:
https://gitlab.com/pycqa/flake8/issues/248

3.0.4


  • Side-step a Pickling Error when using Flake8 with multiprocessing on Unix
    systems. (See also GitLab164_)
  • Fix an Attribute Error raised when dealing with Invalid Syntax. (See also
    GitLab203_)
  • Fix an unhandled Syntax Error when tokenizing files. (See also
    GitLab205_)

.. links
.. _GitLab164:
https://gitlab.com/pycqa/flake8/issues/164
.. _GitLab203:
https://gitlab.com/pycqa/flake8/issues/203
.. _GitLab205:
https://gitlab.com/pycqa/flake8/issues/205

3.0.3


  • Disable --jobs for any version of Python on Windows.
    (See also this Python bug report_)
  • Raise exception when entry_point in plugin not callable.
    This raises an informative error when a plugin fails to load because its
    entry_point is not callable, which can happen with a plugin which is buggy or
    not updated for the current version of flake8. This is nicer than raising a
    PicklingError about failing to pickle a module (See also GitLab164_)
  • Fix noqa comments followed by a : and explanation broken by
    3.0.0 (See also GitLab178_)
  • Always open our output file in append mode so we do not overwrite log
    messages. (See also GitLab193_)
  • When normalizing path values read from configuration, keep in context the
    directory where the configuration was found so that relative paths work.
    (See also GitLab194_)
  • Fix issue where users were unable to ignore plugin errors that were on
    by default. (See also GitLab195_)
  • Fix our legacy API StyleGuide's init_report method to actually override
    the previous formatter. (See also GitLab200_)

.. links
.. _GitLab164:
https://gitlab.com/pycqa/flake8/issues/164
.. _GitLab178:
https://gitlab.com/pycqa/flake8/issues/178
.. _GitLab193:
https://gitlab.com/pycqa/flake8/issues/193
.. _GitLab194:
https://gitlab.com/pycqa/flake8/issues/193
.. _GitLab195:
https://gitlab.com/pycqa/flake8/issues/195
.. _GitLab200:
https://gitlab.com/pycqa/flake8/issues/200
.. _this Python bug report:
https://bugs.python.org/issue27649

3.0.2


  • Fix local config file discovery. (See also GitLab181_)
  • Fix indexing of column numbers. We accidentally were starting column indices
    at 0 instead of 1.
  • Fix regression in handling of errors like E402 that rely on a combination of
    attributes. (See also GitLab186_)

.. links
.. _GitLab181:
https://gitlab.com/pycqa/flake8/issues/181
.. _GitLab186:
https://gitlab.com/pycqa/flake8/issues/186

3.0.1


  • Fix regression in handling of noqa for multiline strings.
    (See also GitLab177_)
  • Fix regression in handling of --output-file when not also using
    --verbose. (See also GitLab180_)
  • Fix regression in handling of --quiet. (See also GitLab180_)
  • Fix regression in handling of --statistics. (See also GitLab180_)

.. links
.. _GitLab177:
https://gitlab.com/pycqa/flake8/issues/177
.. _GitLab180:
https://gitlab.com/pycqa/flake8/issues/180

3.0.0


  • Drop explicit support for Pythons 2.6, 3.2, and 3.3.
  • Remove dependence on pep8/pycodestyle for file processing, plugin
    dispatching, and more. We now control all of this while keeping backwards
    compatibility.
  • --select and --ignore can now both be specified and try to find the
    most specific rule from each. For example, if you do --select E --ignore E123 then we will report everything that starts with E except for
    E123. Previously, you would have had to do --ignore E123,F,W which
    will also still work, but the former should be far more intuitive.
  • Add support for in-line noqa comments to specify only the error
    codes to be ignored, e.g., noqa: E123,W503
  • Add entry-point for formatters as well as a base class that new formatters
    can inherit from. See the documentation for more details.
  • Add detailed verbose output using the standard library logging module.
  • Enhance our usage of optparse for plugin developers by adding new parameters
    to the add_option that plugins use to register new options.
  • Update --install-hook to require the name of version control system hook
    you wish to install a Flake8.
  • Stop checking sub-directories more than once via the setuptools command
  • When passing a file on standard-in, allow the caller to specify
    --stdin-display-name so the output is properly formatted
  • The Git hook now uses sys.executable to format the shebang line.
    This allows Flake8 to install a hook script from a virtualenv that points to
    that virtualenv's Flake8 as opposed to a global one (without the virtualenv
    being sourced).
  • Print results in a deterministic and consistent ordering when used with
    multiprocessing
  • When using --count, the output is no longer written to stderr.
  • AST plugins can either be functions or classes and all plugins can now
    register options so long as there are callable attributes named as we
    expect.
  • Stop forcibly re-adding .tox, .eggs, and *.eggs to
    --exclude. Flake8 2.x started always appending those three patterns
    to any exclude list (including the default and any user supplied list).
    Flake8 3 has stopped adding these in, so you may see errors when upgrading
    due to these patterns no longer being forcibly excluded by default if you
    have your own exclude patterns specified.

To fix this, add the appropriate patterns to your exclude patterns list.

.. note::

 This item was added in November of 2016, as a result of a bug
 report.

2.6.2


  • Bug Fix packaging error during release process.

2.6.1


  • Bug Update the config files to search for to include setup.cfg and
    tox.ini. This was broken in 2.5.5 when we stopped passing
    config_file to our Style Guide

tox 2.3.1 -> 2.7.0

2.7.0


  • p450: Stop after the first installdeps and first testenv create hooks
    succeed. This changes the default behaviour of tox_testenv_create
    and tox_testenv_install_deps to not execute other registered hooks when
    the first hook returns a result that is not None.
    Thanks Anthony Sottile (asottile).
  • 271 and 464: Improve environment information for users.

New command line parameter: -a show all defined environments -
not just the ones defined in (or generated from) envlist.

New verbosity settings for -l and -a: show user defined descriptions
of the environments. This also works for generated environments from factors
by concatenating factor descriptions into a complete description.

Note that for backwards compatibility with scripts using the output of -l
it's output remains unchanged.

Thanks Gábor Bernát (gaborbernat).

  • 464: Fix incorrect egg-info location for modified package_dir in setup.py.
    Thanks Selim Belhaouane (selimb).
  • 431: Add 'LANGUAGE' to default passed environment variables.
    Thanks Paweł Adamczak (pawalad).
  • 455: Add a Vagrantfile with a customized Arch Linux box for local testing.
    Thanks Oliver Bestwalter (obestwalter).
  • 454: Revert 407, empty commands is not treated as an error.
    Thanks Anthony Sottile (asottile).
  • 446: (infrastructure) Travis CI tests for tox now also run on OS X now.
    Thanks Jason R. Coombs (jaraco).

2.6.0


  • add "alwayscopy" config option to instruct virtualenv to always copy
    files instead of symlinking. Thanks Igor Duarte Cardoso (igordcard).
  • pass setenv variables to setup.py during a usedevelop install.
    Thanks Eli Collins (eli-collins).
  • replace all references to testrun.org with readthedocs ones.
    Thanks Oliver Bestwalter (obestwalter).
  • fix 323 by avoiding virtualenv14 is not used on py32
    (although we don't officially support py32).
    Thanks Jason R. Coombs (jaraco).
  • add Python 3.6 to envlist and CI.
    Thanks Andrii Soldatenko (andriisoldatenko).
  • fix glob resolution from TOX_TESTENV_PASSENV env variable
    Thanks Allan Feldman (a-feld).

2.5.0


  • slightly backward incompatible: fix issue310: the {posargs} substitution
    now properly preserves the tox command line positional arguments. Positional
    arguments with spaces are now properly handled.
    NOTE: if your tox invocation previously used extra quoting for positional arguments to
    work around issue310, you need to remove the quoting. Example:
    tox -- "'some string'" has to now be written simply as
    tox -- "some string"
    thanks holger krekel. You can set minversion = 2.5.0 in the [tox]
    section of tox.ini to make sure people using your tox.ini use the correct version.
  • fix 359: add COMSPEC to default passenv on windows. Thanks
    anthrotype.
  • add support for py36 and py37 and add py36-dev and py37(nightly) to
    travis builds of tox. Thanks John Vandenberg.
  • fix 348: add py2 and py3 as default environments pointing to
    "python2" and "python3" basepython executables. Also fix 347 by
    updating the list of default envs in the tox basic example.
    Thanks Tobias McNulty.
  • make "-h" and "--help-ini" options work even if there is no tox.ini,
    thanks holger krekel.
  • add {:} substitution, which is replaced with os-specific path
    separator, thanks Lukasz Rogalski.
  • fix 305: downloadcache test env config is now ignored as pip-8
    does caching by default. Thanks holger krekel.
  • output from install command in verbose (-vv) mode is now printed to console instead of
    being redirected to file, thanks Lukasz Rogalski
  • fix 399. Make sure {envtmpdir} is created if it doesn't exist at the
    start of a testenvironment run. Thanks Manuel Jacob.
  • fix 316: Lack of commands key in ini file is now treated as an error.
    Reported virtualenv status is 'nothing to do' instead of 'commands
    succeeded', with relevant error message displayed. Thanks Lukasz Rogalski.

2.4.1


  • fix issue380: properly perform substitution again. Thanks Ian
    Cordasco.

2.4.0


  • remove PYTHONPATH from environment during the install phase because a
    tox-run should not have hidden dependencies and the test commands will also
    not see a PYTHONPATH. If this causes unforeseen problems it may be
    reverted in a bugfix release. Thanks Jason R. Coombs.
  • fix issue352: prevent a configuration where envdir==toxinidir and
    refine docs to warn people about changing "envdir". Thanks Oliver Bestwalter and holger krekel.
  • fix issue375, fix issue330: warn against tox-setup.py integration as
    "setup.py test" should really just test with the current interpreter. Thanks Ronny Pfannschmidt.
  • fix issue302: allow cross-testenv substitution where we substitute
    with {x,y} generative syntax. Thanks Andrew Pashkin.
  • fix issue212: allow escaping curly brace chars "{" and "}" if you need the
    chars "{" and "}" to appear in your commands or other ini values.
    Thanks John Vandenberg.
  • addresses issue66: add --workdir option to override where tox stores its ".tox" directory
    and all of the virtualenv environment. Thanks Danring.
  • introduce per-venv list_dependencies_command which defaults
    to "pip freeze" to obtain the list of installed packages.
    Thanks Ted Shaw, Holger Krekel.
  • close issue66: add documentation to jenkins page on how to avoid
    "too long shebang" lines when calling pip from tox. Note that we
    can not use "python -m pip install X" by default because the latter
    adds the CWD and pip will think X is installed if it is there.
    "pip install X" does not do that.
  • new list_dependencies_command to influence how tox determines
    which dependencies are installed in a testenv.
  • (experimental) New feature: When a search for a config file fails, tox tries loading
    setup.cfg with a section prefix of "tox".
  • fix issue275: Introduce hooks tox_runtest_pre``` and tox_runtest_post`` which run before and after the tests of a venv,
    respectively. Thanks to Matthew Schinckel and itxaka serrano.
  • fix issue317: evaluate minversion before tox config is parsed completely.
    Thanks Sachi King for the PR.
  • added the "extras" environment option to specify the extras to use when doing the
    sdist or develop install. Contributed by Alex Grönholm.
  • use pytest-catchlog instead of pytest-capturelog (latter is not
    maintained, uses deprecated pytest API)

2.3.2


  • fix issue314: fix command invocation with .py scripts on windows.
  • fix issue279: allow cross-section substitution when the value contains
    posargs. Thanks Sachi King for the PR.

coverage 4.1 -> 4.4.1

4.4.1


  • No code changes: just corrected packaging for Python 2.7 Linux wheels.

.. _changes_44:

4.4


  • Reports could produce the wrong file names for packages, reporting pkg.py
    instead of the correct pkg/__init__.py. This is now fixed. Thanks, Dirk
    Thomas.
  • XML reports could produce <source> and <class> lines that together
    didn't specify a valid source file path. This is now fixed. (issue 526_)
  • Namespace packages are no longer warned as having no code. (issue 572_)
  • Code that uses sys.settrace(sys.gettrace()) in a file that wasn't being
    coverage-measured would prevent correct coverage measurement in following
    code. An example of this was running doctests programmatically. This is now
    fixed. (issue 575_)
  • Errors printed by the coverage command now go to stderr instead of
    stdout.
  • Running coverage xml in a directory named with non-ASCII characters would
    fail under Python 2. This is now fixed. (issue 573_)

.. _issue 526: https://bitbucket.org/ned/coveragepy/issues/526/generated-xml-invalid-paths-for-cobertura
.. _issue 572: https://bitbucket.org/ned/coveragepy/issues/572/no-python-source-warning-for-namespace
.. _issue 573: https://bitbucket.org/ned/coveragepy/issues/573/cant-generate-xml-report-if-some-source
.. _issue 575: https://bitbucket.org/ned/coveragepy/issues/575/running-doctest-prevents-complete-coverage

4.4b1


  • Some warnings can now be individually disabled. Warnings that can be
    disabled have a short name appended. The [run] disable_warnings setting
    takes a list of these warning names to disable. Closes both issue 96_ and
    issue 355_.
  • The XML report now includes attributes from version 4 of the Cobertura XML
    format, fixing issue 570_.
  • In previous versions, calling a method that used collected data would prevent
    further collection. For example, save(), report(), html_report(), and
    others would all stop collection. An explicit start() was needed to get it
    going again. This is no longer true. Now you can use the collected data and
    also continue measurement. Both issue 79_ and issue 448_ described this
    problem, and have been fixed.
  • Plugins can now find unexecuted files if they choose, by implementing the
    find_executable_files method. Thanks, Emil Madsen.
  • Minimal IronPython support. You should be able to run IronPython programs
    under coverage run, though you will still have to do the reporting phase
    with CPython.
  • Coverage.py has long had a special hack to support CPython's need to measure
    the coverage of the standard library tests. This code was not installed by
    kitted versions of coverage.py. Now it is.

.. _issue 79: https://bitbucket.org/ned/coveragepy/issues/79/save-prevents-harvesting-on-stop
.. _issue 96: https://bitbucket.org/ned/coveragepy/issues/96/unhelpful-warnings-produced-when-using
.. _issue 355: https://bitbucket.org/ned/coveragepy/issues/355/warnings-should-be-suppressable
.. _issue 448: https://bitbucket.org/ned/coveragepy/issues/448/save-and-html_report-prevent-further
.. _issue 570: https://bitbucket.org/ned/coveragepy/issues/570/cobertura-coverage-04dtd-support

.. _changes_434:

4.3.4


  • Fixing 2.6 in version 4.3.3 broke other things, because the too-tricky
    exception wasn't properly derived from Exception, described in issue 556_.
    A newb mistake; it hasn't been a good few days.

.. _issue 556: https://bitbucket.org/ned/coveragepy/issues/556/43-fails-if-there-are-html-files-in-the

.. _changes_433:

4.3.3


  • Python 2.6 support was broken due to a testing exception imported for the
    benefit of the coverage.py test suite. Properly conditionalizing it fixed
    issue 554_ so that Python 2.6 works again.

.. _issue 554: https://bitbucket.org/ned/coveragepy/issues/554/traceback-on-python-26-starting-with-432

.. _changes_432:

4.3.2


  • Using the --skip-covered option on an HTML report with 100% coverage
    would cause a "No data to report" error, as reported in issue 549_. This is
    now fixed; thanks, Loïc Dachary.
  • If-statements can be optimized away during compilation, for example, if 0:
    or if __debug__:. Coverage.py had problems properly understanding these
    statements which existed in the source, but not in the compiled bytecode.
    This problem, reported in issue 522_, is now fixed.
  • If you specified --source as a directory, then coverage.py would look for
    importable Python files in that directory, and could identify ones that had
    never been executed at all. But if you specified it as a package name, that
    detection wasn't performed. Now it is, closing issue 426_. Thanks to Loïc
    Dachary for the fix.
  • If you started and stopped coverage measurement thousands of times in your
    process, you could crash Python with a "Fatal Python error: deallocating
    None" error. This is now fixed. Thanks to Alex Groce for the bug report.
  • On PyPy, measuring coverage in subprocesses could produce a warning: "Trace
    function changed, measurement is likely wrong: None". This was spurious, and
    has been suppressed.
  • Previously, coverage.py couldn't start on Jython, due to that implementation
    missing the multiprocessing module (issue 551). This problem has now been
    fixed. Also, issue 322
    about not being able to invoke coverage
    conveniently, seems much better: jython -m coverage run myprog.py works
    properly.
  • Let's say you ran the HTML report over and over again in the same output
    directory, with --skip-covered. And imagine due to your heroic
    test-writing efforts, a file just acheived the goal of 100% coverage. With
    coverage.py 4.3, the old HTML file with the less-than-100% coverage would be
    left behind. This file is now properly deleted.

.. _issue 322: https://bitbucket.org/ned/coveragepy/issues/322/cannot-use-coverage-with-jython
.. issue 426: https://bitbucket.org/ned/coveragepy/issues/426/difference-between-coverage-results-with
.. issue 522: https://bitbucket.org/ned/coveragepy/issues/522/incorrect-branch-reporting-with-__debug

.. _issue 549: https://bitbucket.org/ned/coveragepy/issues/549/skip-covered-with-100-coverage-throws-a-no
.. _issue 551: https://bitbucket.org/ned/coveragepy/issues/551/coveragepy-cannot-be-imported-in-jython27

.. _changes_431:

4.3.1


  • Some environments couldn't install 4.3, as described in issue 540_. This is
    now fixed.
  • The check for conflicting --source and --include was too simple in a
    few different ways, breaking a few perfectly reasonable use cases, described
    in issue 541. The check has been reverted while we re-think the fix for
    issue 265
    .

.. _issue 540: https://bitbucket.org/ned/coveragepy/issues/540/cant-install-coverage-v43-into-under
.. _issue 541: https://bitbucket.org/ned/coveragepy/issues/541/coverage-43-breaks-nosetest-with-coverage

.. _changes_43:

4.3


Special thanks to Loïc Dachary, who took an extraordinary interest in
coverage.py and contributed a number of improvements in this release.

  • Subprocesses that are measured with automatic subprocess measurement_ used
    to read in any pre-existing data file. This meant data would be incorrectly
    carried forward from run to run. Now those files are not read, so each
    subprocess only writes its own data. Fixes issue 510_.
  • The coverage combine command will now fail if there are no data files to
    combine. The combine changes in 4.2 meant that multiple combines could lose
    data, leaving you with an empty .coverage data file. Fixes
    issue 525, issue 412, issue 516, and probably issue 511.
  • Coverage.py wouldn't execute sys.excepthook_ when an exception happened in
    your program. Now it does, thanks to Andrew Hoos. Closes issue 535_.
  • Branch coverage fixes:
  • Branch coverage could misunderstand a finally clause on a try block that
    never continued on to the following statement, as described in issue 493_. This is now fixed. Thanks to Joe Doherty for the report and Loïc
    Dachary for the fix.
  • A while loop with a constant condition (while True) and a continue
    statement would be mis-analyzed, as described in issue 496_. This is now
    fixed, thanks to a bug report by Eli Skeggs and a fix by Loïc Dachary.
  • While loops with constant conditions that were never executed could result
    in a non-zero coverage report. Artem Dayneko reported this in issue 502_, and Loïc Dachary provided the fix.
  • The HTML report now supports a --skip-covered option like the other
    reporting commands. Thanks, Loïc Dachary for the implementation, closing
    issue 433_.
  • Options can now be read from a tox.ini file, if any. Like setup.cfg, sections
    are prefixed with "coverage:", so [run] options will be read from the
    [coverage:run] section of tox.ini. Implements part of issue 519_.
    Thanks, Stephen Finucane.
  • Specifying both --source and --include no longer silently ignores the
    include setting, instead it fails with a message. Thanks, Nathan Land and
    Loïc Dachary. Closes issue 265_.
  • The Coverage.combine method has a new parameter, strict=False, to
    support failing if there are no data files to combine.
  • When forking subprocesses, the coverage data files would have the same random
    number appended to the file name. This didn't cause problems, because the
    file names had the process id also, making collisions (nearly) impossible.
    But it was disconcerting. This is now fixed.
  • The text report now properly sizes headers when skipping some files, fixing
    issue 524_. Thanks, Anthony Sottile and Loïc Dachary.
  • Coverage.py can now search .pex files for source, just as it can .zip and
    .egg. Thanks, Peter Ebden.
  • Data files are now about 15% smaller.
  • Improvements in the [run] debug setting:
  • The "dataio" debug setting now also logs when data files are deleted during
    combining or erasing.
  • A new debug option, "multiproc", for logging the behavior of
    concurrency=multiprocessing.
  • If you used the debug options "config" and "callers" together, you'd get a
    call stack printed for every line in the multi-line config output. This is
    now fixed.
  • Fixed an unusual bug involving multiple coding declarations affecting code
    containing code in multi-line strings: issue 529_.
  • Coverage.py will no longer be misled into thinking that a plain file is a
    package when interpreting --source options. Thanks, Cosimo Lupo.
  • If you try to run a non-Python file with coverage.py, you will now get a more
    useful error message. Issue 514_.
  • The default pragma regex changed slightly, but this will only matter to you
    if you are deranged and use mixed-case pragmas.
  • Deal properly with non-ASCII file names in an ASCII-only world, issue 533_.
  • Programs that set Unicode configuration values could cause UnicodeErrors when
    generating HTML reports. Pytest-cov is one example. This is now fixed.
  • Prevented deprecation warnings from configparser that happened in some
    circumstances, closing issue 530_.
  • Corrected the name of the jquery.ba-throttle-debounce.js library. Thanks,
    Ben Finney. Closes issue 505_.
  • Testing against PyPy 5.6 and PyPy3 5.5.
  • Switched to pytest from nose for running the coverage.py tests.
  • Renamed AUTHORS.txt to CONTRIBUTORS.txt, since there are other ways to
    contribute than by writing code. Also put the count of contributors into the
    author string in setup.py, though this might be too cute.

.. _sys.excepthook: https://docs.python.org/3/library/sys.htmlsys.excepthook
.. _issue 265: https://bitbucket.org/ned/coveragepy/issues/265/when-using-source-include-is-silently
.. _issue 412: https://bitbucket.org/ned/coveragepy/issues/412/coverage-combine-should-error-if-no
.. _issue 433: https://bitbucket.org/ned/coveragepy/issues/433/coverage-html-does-not-suport-skip-covered
.. _issue 493: https://bitbucket.org/ned/coveragepy/issues/493/confusing-branching-failure
.. _issue 496: https://bitbucket.org/ned/coveragepy/issues/496/incorrect-coverage-with-branching-and
.. _issue 502: https://bitbucket.org/ned/coveragepy/issues/502/incorrect-coverage-report-with-cover
.. _issue 505: https://bitbucket.org/ned/coveragepy/issues/505/use-canonical-filename-for-debounce
.. _issue 514: https://bitbucket.org/ned/coveragepy/issues/514/path-to-problem-file-not-reported-when
.. _issue 510: https://bitbucket.org/ned/coveragepy/issues/510/erase-still-needed-in-42
.. _issue 511: https://bitbucket.org/ned/coveragepy/issues/511/version-42-coverage-combine-empties
.. _issue 516: https://bitbucket.org/ned/coveragepy/issues/516/running-coverage-combine-twice-deletes-all
.. _issue 519: https://bitbucket.org/ned/coveragepy/issues/519/coverage-run-sections-in-toxini-or-as
.. _issue 524: https://bitbucket.org/ned/coveragepy/issues/524/coverage-report-with-skip-covered-column
.. _issue 525: https://bitbucket.org/ned/coveragepy/issues/525/coverage-combine-when-not-in-parallel-mode
.. _issue 529: https://bitbucket.org/ned/coveragepy/issues/529/encoding-marker-may-only-appear-on-the
.. _issue 530: https://bitbucket.org/ned/coveragepy/issues/530/deprecationwarning-you-passed-a-bytestring
.. _issue 533: https://bitbucket.org/ned/coveragepy/issues/533/exception-on-unencodable-file-name
.. _issue 535: https://bitbucket.org/ned/coveragepy/issues/535/sysexcepthook-is-not-called

.. _changes_42:

4.2


  • Since concurrency=multiprocessing uses subprocesses, options specified on
    the coverage.py command line will not be communicated down to them. Only
    options in the configuration file will apply to the subprocesses.
    Previously, the options didn't apply to the subprocesses, but there was no
    indication. Now it is an error to use --concurrency=multiprocessing and
    other run-affecting options on the command line. This prevents
    failures like those reported in issue 495_.
  • Filtering the HTML report is now faster, thanks to Ville Skyttä.

.. _issue 495: https://bitbucket.org/ned/coveragepy/issues/495/branch-and-concurrency-are-conflicting

4.2b1


Work from the PyCon 2016 Sprints!

  • BACKWARD INCOMPATIBILITY: the coverage combine command now ignores an
    existing .coverage data file. It used to include that file in its
    combining. This caused confusing results, and extra tox "clean" steps. If
    you want the old behavior, use the new coverage combine --append option.
  • The concurrency option can now take multiple values, to support programs
    using multiprocessing and another library such as eventlet. This is only
    possible in the configuration file, not from the command line. The
    configuration file is the only way for sub-processes to all run with the same
    options. Fixes issue 484_. Thanks to Josh Williams for prototyping.
  • Using a concurrency setting of multiprocessing now implies
    --parallel so that the main program is measured similarly to the
    sub-processes.
  • When using automatic subprocess measurement, running coverage commands
    would create spurious data files. This is now fixed, thanks to diagnosis and
    testing by Dan Riti. Closes issue 492
    .
  • A new configuration option, report:sort, controls what column of the
    text report is used to sort the rows. Thanks to Dan Wandschneider, this
    closes issue 199_.
  • The HTML report has a more-visible indicator for which column is being
    sorted. Closes issue 298_, thanks to Josh Williams.
  • If the HTML report cannot find the source for a file, the message now
    suggests using the -i flag to allow the report to continue. Closes
    issue 231_, thanks, Nathan Land.
  • When reports are ignoring errors, there's now a warning if a file cannot be
    parsed, rather than being silently ignored. Closes issue 396_. Thanks,
    Matthew Boehm.
  • A new option for coverage debug is available: coverage debug config
    shows the current configuration. Closes issue 454_, thanks to Matthew
    Boehm.
  • Running coverage as a module (python -m coverage) no longer shows the
    program name as __main__.py. Fixes issue 478_. Thanks, Scott Belden.
  • The test_helpers module has been moved into a separate pip-installable
    package: unittest-mixins_.

.. _automatic subprocess measurement: http://coverage.readthedocs.io/en/latest/subprocess.html
.. _issue 199: https://bitbucket.org/ned/coveragepy/issues/199/add-a-way-to-sort-the-text-report
.. _issue 231: https://bitbucket.org/ned/coveragepy/issues/231/various-default-behavior-in-report-phase
.. _issue 298: https://bitbucket.org/ned/coveragepy/issues/298/show-in-html-report-that-the-columns-are
.. _issue 396: https://bitbucket.org/ned/coveragepy/issues/396/coverage-xml-shouldnt-bail-out-on-parse
.. _issue 454: https://bitbucket.org/ned/coveragepy/issues/454/coverage-debug-config-should-be
.. _issue 478: https://bitbucket.org/ned/coveragepy/issues/478/help-shows-silly-program-name-when-running
.. _issue 484: https://bitbucket.org/ned/coveragepy/issues/484/multiprocessing-greenlet-concurrency
.. _issue 492: https://bitbucket.org/ned/coveragepy/issues/492/subprocess-coverage-strange-detection-of
.. _unittest-mixins: https://pypi.python.org/pypi/unittest-mixins

.. _changes_41:

Sphinx 1.4.8 -> 1.6.2

1.6.2

=====================================

Incompatible changes

  • 3789: Do not require typing module for python>=3.5

Bugs fixed

  • 3754: HTML builder crashes if HTML theme appends own stylesheets
  • 3756: epub: Entity 'mdash' not defined
  • 3758: Sphinx crashed if logs are emitted in conf.py
  • 3755: incorrectly warns about dedent with literalinclude
  • 3742: RTD <https://readthedocs.org/>_ PDF builds of Sphinx own docs are
    missing an index entry in the bookmarks and table of contents. This is
    rtfd/readthedocs.org2857 <https://github.com/rtfd/readthedocs.org/issues/2857>_ issue, a workaround
    is obtained using some extra LaTeX code in Sphinx's own :file:conf.py
  • 3770: Build fails when a "code-block" has the option emphasize-lines and the
    number indicated is higher than the number of lines
  • 3774: Incremental HTML building broken when using citations
  • 3772: 'str object' has no attribute 'filename'
  • 3763: got epubcheck validations error if epub_cover is set
  • 3779: 'ImportError' in sphinx.ext.autodoc due to broken 'sys.meta_path'.
    Thanks to Tatiana Tereshchenko.
  • 3796: env.resolve_references() crashes when non-document node given
  • 3803: Sphinx crashes with invalid PO files
  • 3791: PDF "continued on next page" for long tables isn't internationalized
  • 3788: smartquotes emits warnings for unsupported languages
  • 3807: latex Makefile for make latexpdf is only for unixen
  • 3781: double hyphens in option directive are compiled as endashes
  • 3817: latex builder raises AttributeError

1.6.1

=====================================

Dependencies

1.6

  • LDML format support in i18n feature
  • sphinx.addnodes.termsep
  • Some functions and classes in sphinx.util.pycompat:
    zip_longest, product, all, any, next, open,
    class_types, base_exception, relpath, StringIO, BytesIO.
    Please use the standard library version instead;

If any deprecation warning like RemovedInSphinxXXXWarning are displayed,
please refer :ref:when-deprecation-warnings-are-displayed.

Features added

1.6b3

  • 3588: No compact (p tag) html output in the i18n document build even when
    :confval:html_compact_lists is True.
  • The make latexpdf from 1.6b1 (for GNU/Linux and Mac OS, using
    latexmk) aborted earlier in case of LaTeX errors than was the case with
    1.5 series, due to hard-coded usage of --halt-on-error option. (refs 3695)
  • 3683: sphinx.websupport module is not provided by default
  • 3683: Failed to build document if builder.css_file.insert() is called
  • 3714: viewcode extension not taking highlight_code='none' in account
  • 3698: Moving :doc: to std domain broke backwards compatibility
  • 3633: misdetect unreferenced citations

1.6b2

  • 3662: builder.css_files is deprecated. Please use add_stylesheet()
    API instead.

1.6b1

  • sphinx.util.compat.Directive class is now deprecated. Please use
    docutils.parsers.rst.Directive instead.
  • sphinx.util.compat.docutils_version is now deprecated
  • 2367: Sphinx.warn(), Sphinx.info() and other logging methods are now
    deprecated. Please use sphinx.util.logging (:ref:logging-api) instead.
  • 3318: notice is now deprecated as LaTeX environment name and will be
    removed at Sphinx 1.7. Extension authors please use sphinxadmonition
    instead (as Sphinx does since 1.5.)
  • Sphinx.status_iterator() and Sphinx.old_status_iterator() is now
    deprecated. Please use sphinx.util:status_iterator() instead.
  • Sphinx._directive_helper() is deprecated. Please use
    sphinx.util.docutils.directive_helper() instead.
  • BuildEnvironment.set_warnfunc() is now deprecated
  • Following methods of BuildEnvironment is now deprecated.
  • BuildEnvironment.note_toctree()
  • BuildEnvironment.get_toc_for()
  • BuildEnvironment.get_toctree_for()
  • BuildEnvironment.create_index()

Please use sphinx.environment.adapters modules instead.

  • latex package footnote is not loaded anymore by its bundled replacement
    footnotehyper-sphinx. The redefined macros keep the same names as in the
    original package.
  • 3429: deprecate config setting latex_keep_old_macro_names. It will be
    removed at 1.7, and already its default value has changed from True to
    False.
  • 3221: epub2 builder is deprecated
  • 3254: sphinx.websupport is now separated into independent package;
    sphinxcontrib-websupport. sphinx.websupport will be removed in
    Sphinx-2.0.
  • 3628: sphinx_themes entry_point is deprecated. Please use
    sphinx.html_themes instead.

1.5.6

=====================================

Bugs fixed

  • 3614: Sphinx crashes with requests-2.5.0
  • 3618: autodoc crashes with tupled arguments
  • 3664: No space after the bullet in items of a latex list produced by Sphinx
  • 3657: EPUB builder crashes if document startswith genindex exists
  • 3588: No compact (p tag) html output in the i18n document build even when
    :confval:html_compact_lists is True.
  • 3685: AttributeError when using 3rd party domains
  • 3702: LaTeX writer styles figure legends with a hard-coded \small
  • 3708: LaTeX writer allows irc scheme
  • 3717: Stop enforcing that favicon's must be .ico
  • 3731, 3732: Protect isenumclass predicate against non-class arguments
  • 3320: Warning about reference target not being found for container types
  • Misspelled ARCHIVEPREFIX in Makefile for latex build repertory

1.5.5

=====================================

Bugs fixed

  • 3597: python domain raises UnboundLocalError if invalid name given
  • 3599: Move to new Mathjax CDN

1.5.4

=====================================

Features added

  • 3470: Make genindex support all kinds of letters, not only Latin ones

Bugs fixed

  • 3445: setting 'inputenc' key to \\usepackage[utf8x]{inputenc} leads
    to failed PDF build
  • EPUB file has duplicated nav.xhtml link in content.opf
    except first time build
  • 3488: objects.inv has broken when release or version contain
    return code
  • 2073, 3443, 3490: gettext builder that writes pot files unless the content
    are same without creation date. Thanks to Yoshiki Shibukawa.
  • 3487: intersphinx: failed to refer options
  • 3496: latex longtable's last column may be much wider than its contents
  • 3507: wrong quotes in latex output for productionlist directive
  • 3533: Moving from Sphinx 1.3.1 to 1.5.3 breaks LaTeX compilation of links
    rendered as code
  • 2665, 2607: Link names in C++ docfields, and make it possible for other domains.
  • 3542: C++, fix parsing error of non-type template argument with template.
  • 3065, 3520: python domain fails to recognize nested class
  • 3575: Problems with pdflatex in a Turkish document built with sphinx has
    reappeared (refs 2997, 2397)
  • 3577: Fix intersphinx debug tool
  • A LaTeX command such as \\large inserted in the title items of
    :confval:latex_documents causes failed PDF build (refs 3551, 3567)

1.5.3

=====================================

Features added

  • Support requests-2.0.0 (experimental) (refs: 3367)
  • (latex) PDF page margin dimensions may be customized (refs: 3387)
  • literalinclude directive allows combination of :pyobject: and
    :lines: options (refs: 3416)
  • 3400: make-mode doesn't use subprocess on building docs

Bugs fixed

  • 3370: the caption of code-block is not picked up for translation
  • LaTeX: :confval:release is not escaped (refs: 3362)
  • 3364: sphinx-quickstart prompts overflow on Console with 80 chars width
  • since 1.5, PDF's TOC and bookmarks lack an entry for general Index
    (refs: 3383)
  • 3392: 'releasename' in :confval:latex_elements is not working
  • 3356: Page layout for Japanese 'manual' docclass has a shorter text area
  • 3394: When 'pointsize' is not 10pt, Japanese 'manual' document
    gets wrong PDF page dimensions
  • 3399: quickstart: conf.py was not overwritten by template
  • 3366: option directive does not allow punctuations
  • 3410: return code in :confval:release breaks html search
  • 3427: autodoc: memory addresses are not stripped on Windows
  • 3428: xetex build tests fail due to fontspec v2.6 defining \strong
  • 3349: Result of IndexBuilder.load() is broken
  • 3450: &nbsp is appeared in EPUB docs
  • 3418: Search button is misaligned in nature and pyramid theme
  • 3421: Could not translate a caption of tables
  • 3552: linkcheck raises UnboundLocalError

1.5.2

=====================================

Incompatible changes

  • Dependency requirement updates: requests 2.4.0 or above (refs: 3268, 3310)

Features added

  • 3241: emit latex warning if buggy titlesec (ref 3210)
  • 3194: Refer the $MAKE environment variable to determine make command
  • Emit warning for nested numbered toctrees (refs: 3142)
  • 978: intersphinx_mapping also allows a list as a parameter
  • 3340: (LaTeX) long lines in :dudir:parsed-literal are wrapped like in
    :rst:dir:code-block, inline math and footnotes are fully functional.

Bugs fixed

  • 3246: xapian search adapter crashes
  • 3253: In Py2 environment, building another locale with a non-captioned
    toctree produces None captions
  • 185: References to section title including raw node has broken
  • 3255: In Py3.4 environment, autodoc doesn't support documentation for
    attributes of Enum class correctly.
  • 3261: latex_use_parts makes sphinx crash
  • The warning type misc.highlighting_failure does not work
  • 3294: add_latex_package() make crashes non-LaTeX builders
  • The caption of table are rendered as invalid HTML (refs: 3287)
  • 3268: Sphinx crashes with requests package from Debian jessie
  • 3284: Sphinx crashes on parallel build with an extension which raises
    unserializable exception
  • 3315: Bibliography crashes on latex build with docclass 'memoir'
  • 3328: Could not refer rubric implicitly
  • 3329: emit warnings if po file is invalid and can't read it. Also writing mo too
  • 3337: Ugly rendering of definition list term's classifier
  • 3335: gettext does not extract field_name of a field in a field_list
  • 2952: C++, fix refs to operator() functions.
  • Fix Unicode super- and subscript digits in :rst:dir:code-block and
    parsed-literal LaTeX output (ref 3342)
  • LaTeX writer: leave " character inside parsed-literal as is (ref 3341)
  • 3234: intersphinx failed for encoded inventories
  • 3158: too much space after captions in PDF output
  • 3317: An URL in parsed-literal contents gets wrongly rendered in PDF if
    with hyphen
  • LaTeX crash if the filename of an image inserted in parsed-literal
    via a substitution contains an hyphen (ref 3340)
  • LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref 3340)
  • Inline math in parsed-literal is not rendered well by LaTeX (ref 3340)
  • 3308: Parsed-literals don't wrap very long lines with pdf builder (ref 3340)
  • 3295: Could not import extension sphinx.builders.linkcheck
  • 3285: autosummary: asterisks are escaped twice
  • LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref 3363)
  • Fix parselinenos() could not parse left half open range (cf. "-4")

1.5.1

=====================================

Features added

  • 3214: Allow to suppress "unknown mimetype" warnings from epub builder using
    :confval:suppress_warnings.

Bugs fixed

  • 3195: Can not build in parallel
  • 3198: AttributeError is raised when toctree has 'self'
  • 3211: Remove untranslated sphinx locale catalogs (it was covered by
    untranslated it_IT)
  • 3212: HTML Builders crashes with docutils-0.13
  • 3207: more latex problems with references inside parsed-literal directive
    (\DUrole)
  • 3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
  • 3220: KeyError when having a duplicate citation
  • 3200: LaTeX: xref inside desc_name not allowed
  • 3228: build_sphinx command crashes when missing dependency
  • 2469: Ignore updates of catalog files for gettext builder. Thanks to
    Hiroshi Ohkubo.
  • 3183: Randomized jump box order in generated index page.

1.5

  • 3069: Even if &#39;babel&#39; key is set to empty string, LaTeX output contains
    one \addto\captions...
  • 3123: user &#39;babel&#39; key setting is not obeyed anymore
  • 3155: Fix JavaScript for html_sourcelink_suffix fails with IE and Opera
  • 3085: keep current directory after breaking build documentation. Thanks to
    Timotheus Kampik.
  • 3181: pLaTeX crashes with a section contains endash
  • 3180: latex: add stretch/shrink between successive singleline or
    multipleline cpp signatures (ref 3072)
  • 3128: globing images does not support .svgz file
  • 3015: fix a broken test on Windows.
  • 1843: Fix documentation of descriptor classes that have a custom metaclass.
    Thanks to Erik Bray.
  • 3190: util.split_docinfo fails to parse multi-line field bodies
  • 3024, 3037: In Python3, application.Sphinx._log crushed when the log message cannot
    be encoded into console encoding.

Testing

  • To simplify, sphinx uses external mock package even if unittest.mock exists.

1.5b1

  • 2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex Grönholm.
  • 3062: Failed to build PDF using 1.5a2 (undefined \hypersetup for
    Japanese documents since PR3030)
  • Better rendering of multiline signatures in html.
  • 777: LaTeX output "too deeply nested" (ref 3096)
  • Let LaTeX image inclusion obey scale before textwidth fit (ref 2865, 3059)
  • 3019: LaTeX fails on description of C function with arguments (ref 3083)
  • fix latex inline literals where &lt; &gt; - gobbled a space

1.5a2

  • 2810: Problems with pdflatex in an Italian document
  • Use latex_elements.papersize to specify papersize of LaTeX in Makefile
  • 2988: linkcheck: retry with GET request if denied HEAD request
  • 2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error
    if linkcheck_anchors enabled
  • 3004: Invalid link types "top" and "up" are used
  • 3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
  • 3000: option directive generates invalid HTML anchors
  • 2984: Invalid HTML has been generated if html_split_index enabled
  • 2986: themes/basic/defindex.html should be changed for html5 friendly
  • 2987: Invalid HTML has been generated if multiple IDs are assigned to a list
  • 2891: HTML search does not provide all the results
  • 1986: Title in PDF Output
  • 147: Problem with latex chapter style
  • 3018: LaTeX problem with page layout dimensions and chapter titles
  • Fix an issue with \pysigline in LaTeX style file (ref 3023)
  • 3038: sphinx.ext.math* raises TypeError if labels are duplicated
  • 3031: incompatibility with LaTeX package tocloft
  • 3003: literal blocks in footnotes are not supported by Latex
  • 3047: spacing before footnote in pdf output is not coherent and allows breaks
  • 3045: HTML search index creator should ignore "raw" content if now html
  • 3039: English stemmer returns wrong word if the word is capitalized
  • Fix make-mode Makefile template (ref 3056, 2936)

1.5a1

  • 2707: (latex) the column width is badly computed for tabular
  • 2799: Sphinx installs roles and directives automatically on importing sphinx
    module. Now Sphinx installs them on running application.
  • sphinx.ext.autodoc crashes if target code imports * from mock modules
    by autodoc_mock_imports.
  • 1953: Sphinx.add_node does not add handlers the translator installed by
    html_translator_class
  • 1797: text builder inserts blank line on top
  • 2894: quickstart main() doesn't use argv argument
  • 2874: gettext builder could not extract all text under the only
    directives
  • 2485: autosummary crashes with multiple source_suffix values
  • 1734: Could not translate the caption of toctree directive
  • Could not translate the content of meta directive (ref: 1734)
  • 2550: external links are opened in help viewer
  • 2687: Running Sphinx multiple times produces 'already registered' warnings

1.4.9

=====================================

Bugs fixed

  • 2936: Fix doc/Makefile that can't build man because doc/man exists
  • 3058: Using the same 'caption' attribute in multiple 'toctree' directives
    results in warning / error
  • 3068: Allow the '=' character in the -D option of sphinx-build.py
  • 3074: add_source_parser() crashes in debug mode
  • 3135: sphinx.ext.autodoc crashes with plain Callable
  • 3150: Fix query word splitter in JavaScript. It behaves as same as Python's regular expression.
  • 3093: gettext build broken on substituted images.
  • 3093: gettext build broken on image node under note directive.
  • imgmath: crashes on showing error messages if image generation failed
  • 3117: LaTeX writer crashes if admonition is placed before first section title
  • 3164: Change search order of sphinx.ext.inheritance_diagram

cryptography 1.7 -> 1.9

1.9

  • BACKWARDS INCOMPATIBLE: Elliptic Curve signature verification no longer
    returns True on success. This brings it in line with the interface's
    documentation, and our intent. The correct way to use
    :meth:~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey.verify
    has always been to check whether or not
    :class:~cryptography.exceptions.InvalidSignature was raised.
  • BACKWARDS INCOMPATIBLE: Dropped support for macOS 10.7 and 10.8.
  • BACKWARDS INCOMPATIBLE: The minimum supported PyPy version is now 5.3.
  • Python 3.3 support has been deprecated, and will be removed in the next
    cryptography release.
  • Add support for providing tag during
    :class:~cryptography.hazmat.primitives.ciphers.modes.GCM finalization via
    :meth:~cryptography.hazmat.primitives.ciphers.AEADDecryptionContext.finalize_with_tag.
  • Fixed an issue preventing cryptography from compiling against
    LibreSSL 2.5.x.
  • Added
    :meth:~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey.key_size
    and
    :meth:~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey.key_size
    as convenience methods for determining the bit size of a secret scalar for
    the curve.
  • Accessing an unrecognized extension marked critical on an X.509 object will
    no longer raise an UnsupportedExtension exception, instead an
    :class:~cryptography.x509.UnrecognizedExtension object will be returned.
    This behavior was based on a poor reading of the RFC, unknown critical
    extensions only need to be rejected on certificate verification.
  • The CommonCrypto backend has been removed.
  • MultiBackend has been removed.
  • Whirlpool and RIPEMD160 have been deprecated.

1.8.2

  • Fixed a compilation bug affecting OpenSSL 1.1.0f.
  • Updated Windows and macOS wheels to be compiled against OpenSSL 1.1.0f.

1.8.1

  • Fixed macOS wheels to properly link against 1.1.0 rather than 1.0.2.

1.8

  • Added support for Python 3.6.
  • Windows and macOS wheels now link against OpenSSL 1.1.0.
  • macOS wheels are no longer universal. This change significantly shrinks the
    size of the wheels. Users on macOS 32-bit Python (if there are any) should
    migrate to 64-bit or build their own packages.
  • Changed ASN.1 dependency from pyasn1 to asn1crypto resulting in a
    general performance increase when encoding/decoding ASN.1 structures. Also,
    the pyasn1_modules test dependency is no longer required.
  • Added support for
    :meth:~cryptography.hazmat.primitives.ciphers.CipherContext.update_into on
    :class:~cryptography.hazmat.primitives.ciphers.CipherContext.
  • Added
    :meth:~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKeyWithSerialization.private_bytes
    to
    :class:~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKeyWithSerialization.
  • Added
    :meth:~cryptography.hazmat.primitives.asymmetric.dh.DHPublicKeyWithSerialization.public_bytes
    to
    :class:`~cryptography.hazmat.pri

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant