Initial Update

[pyup-bot]

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.

sh	1.11	»	1.12.14	PyPI | Changelog | Repo
lxml	3.6.0	»	3.8.0	PyPI | Changelog | Homepage | Bugtracker
wheel	0.23.0	»	0.29.0	PyPI | Changelog | Repo
flake8	2.4.1	»	3.3.0	PyPI | Changelog | Repo
pydocstyle	1.0.0	»	2.0.0	PyPI | Changelog | Repo
tox	2.1.1	»	2.7.0	PyPI | Changelog | Docs
coverage	4.0	»	4.4.1	PyPI | Changelog | Docs
Sphinx	1.3.1	»	1.6.3	PyPI | Changelog | Homepage

Changelogs

sh 1.11 -> 1.12.14

1.12.14

• bugfix for poor sleep performance 378
• allow passing raw integer file descriptors for _out and _err handlers
• bugfix for when _tee and _out are used, and the _out is a tty or pipe 384
• bugfix where python 3.3+ detected different arg counts for bound method output callbacks 380

1.12.12

• pypi readme doc bugfix PR377

1.12.11

• bugfix for relative paths to sh.Command not expanding to absolute paths 372
• updated for python 3.6
• bugfix for SIGPIPE not being handled correctly on pipelined processes 373

1.12.10

• bugfix for file descriptors over 1024 356
• bugfix when _err_to_out is True and _out is pipe or tty 365

1.12.9

• added _bg_exc for silencing exceptions in background threads 350

1.12.8

• bugfix for patched glob.glob on python3.5 341

1.12.7

• added _out and _out_bufsize validator 346
• bugfix for internal stdout thread running when it shouldn't 346

1.12.6

• regression bugfix on timeout 344
• regression bugfix on _ok_code=None

1.12.5

• further improvements on cpu usage

1.12.4

• regression in cpu usage 339

1.12.3

• fd leak regression and fix for flawed fd leak detection test 337

1.12.2

• support for io.StringIO in python2

1.12.1

• added support for using raw file descriptors for _in, _out, and _err
• removed .close()ing _out handler if FIFO detected

1.12.0

• composed commands no longer propagate _bg
• better support for using sys.stdin and sys.stdout for _in and _out
• bugfix where which() would not stop searching at the first valid executable found in PATH
• added _long_prefix for programs whose long arguments start with something other than -- 278
• added _log_msg for advanced configuration of log message 311
• added sh.contrib.sudo
• added _arg_preprocess for advanced command wrapping
• alter callable _in arguments to signify completion with falsy chunk
• bugfix where pipes passed into _out or _err were not flushed on process end 252
• deprecated with sh.args(**kwargs) in favor of sh2 = sh(**kwargs)
• made sh.pushd thread safe
• added .kill_group() and .signal_group() methods for better process control 237
• added new_session special keyword argument for controlling spawned process session 266
• bugfix better handling for EINTR on system calls 292
• bugfix where with-contexts were not threadsafe 247
• _uid new special keyword param for specifying the user id of the process 133
• bugfix where exceptions were swallowed by processes that weren't waited on 309
• bugfix where processes that dupd their stdout/stderr to a long running child process would cause sh to hang 310
• improved logging output 323
• bugfix for python3+ where binary data was passed into a process's stdin 325
• Introduced execution contexts which allow baking of common special keyword arguments into all commands 269
• Command and which now can take an optional paths parameter which specifies the search paths 226
• _preexec_fn option for executing a function after the child process forks but before it execs 260
• _fg reintroduced, with limited functionality. hurrah! 92
• bugfix where a command would block if passed a fd for stdin that wasn't yet ready to read 253
• _long_sep can now take None which splits the long form arguments into individual arguments 258
• making _piped perform "direct" piping by default (linking fds together). this fixes memory problems 270
• bugfix where calling next() on an iterable process that has raised StopIteration, hangs 273
• sh.cd called with no arguments no changes into the user's home directory, like native cd 275
• sh.glob removed entirely. the rationale is correctness over hand-holding. 279
• added _truncate_exc, defaulting to True, which tells our exceptions to truncate output.
• bugfix for exceptions whose messages contained unicode
• _done callback no longer assumes you want your command put in the background.
• _done callback is now called asynchronously in a separate thread.
• _done callback is called regardless of exception, which is necessary in order to release held resources, for example a process pool

lxml 3.6.0 -> 3.8.0

3.8.0

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

Features added

• ElementTree.write() has a new option doctype that writes out a
  doctype string before the serialisation, in the same way as tostring().

• GH220: xmlfile allows switching output methods at an element level.
  Patch by Burak Arslan.

• LP1595781, GH240: added a PyCapsule Python API and C-level API for
  passing externally generated libxml2 documents into lxml.

• GH244: error log entries have a new property path with an XPath
  expression (if known, None otherwise) that points to the tree element
  responsible for the error. Patch by Bob Kline.

• The namespace prefix mapping that can be used in ElementPath now injects
  a default namespace when passing a None prefix.

Bugs fixed

• GH238: Character escapes were not hex-encoded in the xmlfile serialiser.
  Patch by matejcik.

• GH229: fix for externally created XML documents. Patch by Theodore Dubois.

• LP1665241, GH228: Form data handling in lxml.html no longer strips the
  option values specified in form attributes but only the text values.
  Patch by Ashish Kulkarni.

• LP1551797: revert previous fix for XSLT error logging as it breaks
  multi-threaded XSLT processing.

• LP1673355, GH233: fromstring() html5parser failed to parse byte strings.

Other changes

• The previously undocumented docstring option in ElementTree.write()
  produces a deprecation warning and will eventually be removed.

3.7.4

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

Bugs fixed

• LP1551797: revert previous fix for XSLT error logging as it breaks
  multi-threaded XSLT processing.

• LP1673355, GH233: fromstring() html5parser failed to parse byte strings.

3.7.3

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

Bugs fixed

• GH218 was ineffective in Python 3.

• GH222: lxml.html.submit_form() failed in Python 3.
  Patch by Jakub Wilk.

3.7.2

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

• GH220: xmlfile allows switching output methods at an element level.
  Patch by Burak Arslan.

Bugs fixed

• Work around installation problems in recent Python 2.7 versions
  due to FTP download failures.

• GH219: xmlfile.element() was not properly quoting attribute values.
  Patch by Burak Arslan.

• GH218: xmlfile.element() was not properly escaping text content of
  script/style tags. Patch by Burak Arslan.

3.7.1

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

• No source changes, issued only to solve problems with the
  binary packages released for 3.7.0.

3.7.0

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

Features added

• GH217: XMLSyntaxError now behaves more like its SyntaxError
  baseclass. Patch by Philipp A.

• GH216: HTMLParser() now supports the same collect_ids parameter
  as XMLParser(). Patch by Burak Arslan.

• GH210: Allow specifying a serialisation method in xmlfile.write().
  Patch by Burak Arslan.

• GH203: New option default_doctype in HTMLParser that allows
  disabling the automatic doctype creation. Patch by Shadab Zafar.

• GH201: Calling the method .set('attrname') without value argument
  (or None) on HTML elements creates an attribute without value that
  serialises like <div attrname></div>. Patch by Daniel Holth.

• GH197: Ignore form input fields in form_values() when they are
  marked as disabled in HTML. Patch by Kristian Klemon.

Bugs fixed

• GH206: File name and line number were missing from XSLT error messages.
  Patch by Marcus Brinkmann.

Other changes

• Log entries no longer allow anything but plain string objects as message text
  and file name.

• zlib is included in the list of statically built libraries.

3.6.4

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

• GH204, LP1614693: build fix for MacOS-X.

3.6.3

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

• LP1614603: change linker flags to build multi-linux wheels

3.6.2

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

• LP1614603: release without source changes to provide cleanly built Linux wheels

3.6.1

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

Features added

• GH180: Separate option inline_style for Cleaner that only removes style
  attributes instead of all styles. Patch by Christian Pedersen.

• GH196: Windows build support for Python 3.5. Contribution by Maximilian Hils.

Bugs fixed

• GH199: Exclude file fields from FormElement.form_values (as browsers do).
  Patch by Tomas Divis.

• GH198, LP1568167: Try to provide base URL from Resolver.resolve_string().
  Patch by Michael van Tellingen.

• GH191: More accurate float serialisation in objectify.FloatElement.
  Patch by Holger Joukl.

• LP1551797: Repair XSLT error logging. Patch by Marcus Brinkmann.

wheel 0.23.0 -> 0.29.0

0.29.0

======

• Fix compression type of files in archive (Issue 155, Pull Request 62,
  thanks Xavier Fernandez)

0.28.0

======

• Fix file modes in archive (Issue 154)

0.27.0

======

• Support forcing a platform tag using --plat-name on pure-Python wheels, as
  well as nonstandard platform tags on non-pure wheels (Pull Request 60, Issue
  144, thanks Andrés Díaz)
• Add SOABI tags to platform-specific wheels built for Python 2.X (Pull Request
  55, Issue 63, Issue 101)
• Support reproducible wheel files, wheels that can be rebuilt and will hash to
  the same values as previous builds (Pull Request 52, Issue 143, thanks
  Barry Warsaw)
• Support for changes in keyring >= 8.0 (Pull Request 61, thanks Jason R.
  Coombs)
• Use the file context manager when checking if dependency_links.txt is empty,
  fixes problems building wheels under PyPy on Windows (Issue 150, thanks
  Cosimo Lupo)
• Don't attempt to (recursively) create a build directory ending with ..
  (invalid on all platforms, but code was only executed on Windows) (Issue 91)
• Added the PyPA Code of Conduct (Pull Request 56)

0.26.0

======

• Fix multiple entrypoint comparison failure on Python 3 (Issue 148)

0.25.0

======

• Add Python 3.5 to tox configuration
• Deterministic (sorted) metadata
• Fix tagging for Python 3.5 compatibility
• Support py2-none-'arch' and py3-none-'arch' tags
• Treat data-only wheels as pure
• Write to temporary file and rename when using wheel install --force

0.24.0

======

• The python tag used for pure-python packages is now .pyN (major version
  only). This change actually occurred in 0.23.0 when the --python-tag
  option was added, but was not explicitly mentioned in the changelog then.
• wininst2wheel and egg2wheel removed. Use "wheel convert [archive]"
  instead.
• Wheel now supports setuptools style conditional requirements via the
  extras_require={} syntax. Separate 'extra' names from conditions using
  the : character. Wheel's own setup.py does this. (The empty-string
  extra is the same as install_requires.) These conditional requirements
  should work the same whether the package is installed by wheel or
  by setup.py.

flake8 2.4.1 -> 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

---

• Rewrite our documentation from scratch! (http://flake8.pycqa.org)

• 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

2.6.0

---

• Requirements Change Switch to pycodestyle as all future pep8 releases
  will use that package name

• Improvement Allow for Windows users on select versions of Python to
  use --jobs and multiprocessing

• Improvement Update bounds on McCabe

• Improvement Update bounds on PyFlakes and blacklist known broken
  versions

• Improvement Handle new PyFlakes warning with a new error code: F405

2.5.5

---

• Bug Fix setuptools integration when parsing config files

• Bug Don't pass the user's config path as the config_file when creating a
  StyleGuide

2.5.4

---

• Bug Missed an attribute rename during the v2.5.3 release.

2.5.3

---

• Bug Actually parse output_file and enable_extensions from config
  files

2.5.2

---

• Bug Parse output_file and enable_extensions from config files

• Improvement Raise upper bound on mccabe plugin to allow for version
  0.4.0

2.5.1

---

• Bug Properly look for .flake8 in current working directory
  (GitLab103_)

• Bug Monkey-patch pep8.stdin_get_value to cache the actual value in
  stdin. This helps plugins relying on the function when run with
  multiprocessing. (GitLab105, GitLab107)

.. _GitLab103: https://gitlab.com/pycqa/flake8/issues/103
.. _GitLab105: https://gitlab.com/pycqa/flake8/issues/105
.. _GitLab107: https://gitlab.com/pycqa/flake8/issues/107

2.5.0

---

• Improvement Raise cap on PyFlakes for Python 3.5 support

• Improvement Avoid deprecation warnings when loading extensions
  (GitLab59, GitLab90)

• Improvement Separate logic to enable "off-by-default" extensions
  (GitLab67_)

• Bug Properly parse options to setuptools Flake8 command (GitLab!41_)

• Bug Fix exceptions when output on stdout is truncated before Flake8
  finishes writing the output (GitLab69_)

• Bug Fix error on OS X where Flake8 can no longer acquire or create new
  semaphores (GitLab74_)

.. _GitLab!41: https://gitlab.com/pycqa/flake8/merge_requests/41
.. _GitLab59: https://gitlab.com/pycqa/flake8/issues/59
.. _GitLab67: https://gitlab.com/pycqa/flake8/issues/67
.. _GitLab69: https://gitlab.com/pycqa/flake8/issues/69
.. _GitLab74: https://gitlab.com/pycqa/flake8/issues/74
.. _GitLab90: https://gitlab.com/pycqa/flake8/issues/90

pydocstyle 1.0.0 -> 2.0.0

2.0.0

Major Updates

Support for numpy conventions verification has been added (129, 226).
Support for Python 2.6 has been dropped (206, 217).
Support for PyPy3 has been temporarily dropped, until it will be equivalent to CPython 3.3+ and supported by pip (223).
Support for the pep257 console script has been dropped. Only the pydocstyle console script should be used (216, 218).
Errors are now printed to stdout instead of stderr (201, 210).

New Features

Decorator-based skipping via --ignore-decorators has been added (204).
Support for using pycodestyle style wildcards has been added (72, 209).
Superfluous opening quotes are now reported as part of D300 (166, 225).
Fixed a false-positive recognition of D410 and added D412 (230, 233).
Added --config=<path> flag to override the normal config file discovery and choose a specific config file (117, 247).
Support for specifying error codes with partial prefix has been added, e.g., --select=D101,D2 (72, 209).
All configuration file can now have the .ini extension (237).
Added better imperative mood checks using third party stemmer (235, 68).

Bug Fixes

Made parser more robust to bad source files (168, 214)
Modules are now considered private if their name starts with a single underscore. This is a bugfix where “public module” (D100) was reported regardless of module name (199, 222).
Removed error when all is a list (62, 227).
Fixed a bug where the sign was used as a matrix multiplication operator in Python 3.5, but was considered a decorator by the parser (246, 191).

1.1.1

Bug Fixes

• Fixed an issue where the flake8-docstrings failed when accessing some public API from pydocstyle.

1.1.0

Major Updates

• pydocstyle is no longer a single file. This might make it difficult for some users to just add it to their project, but the project has reached certain complexity where splitting it into modules was necessary (200).

New Features

• Added the optional error codes D212 and D213, for checking whether the summary of a multi-line docstring starts at the first line, respectively at the second line (174).
• Added D404 - First word of the docstring should not be “This”. It is turned off by default (183).
• Added the ability to ignore specific function and method docstrings with inline comments:
  “ noqa” skips all checks.
  “ noqa: D102,D203” can be used to skip specific checks.

Bug Fixes

• Fixed an issue where file paths were printed in lower case (179, 181).
• The error code D300 is now also being reported if a docstring has uppercase literals (R or U) as prefix (176).
• Fixed a bug where an all error was reported when all was imported from another module with a different name (182, 187).
• Fixed a bug where raise X from Y syntax caused pydocstyle to crash (196, 200).

tox 2.1.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.

2.3.1

---

• fix issue294: re-allow cross-section substitution for setenv.

2.3.0

---

• DEPRECATE use of "indexservers" in tox.ini. It complicates
  the internal code and it is recommended to rather use the
  devpi system for managing indexes for pip.

• fix issue285: make setenv processing fully lazy to fix regressions
  of tox-2.2.X and so that we can now have testenv attributes like
  "basepython" depend on environment variables that are set in
  a setenv section. Thanks Nelfin for some tests and initial
  work on a PR.

• allow "" in commands. This is slightly incompatible with commands
  sections that used a comment after a "&quot; line continuation.
  Thanks David Stanek for the PR.

• fix issue289: fix build_sphinx target, thanks Barry Warsaw.

• fix issue252: allow environment names with special characters.
  Thanks Julien Castets for initial PR and patience.

• introduce experimental tox_testenv_create(venv, action) and
  tox_testenv_install_deps(venv, action) hooks to allow
  plugins to do additional work on creation or installing
  deps. These hooks are experimental mainly because of
  the involved "venv" and session objects whose current public
  API is not fully guranteed.

• internal: push some optional object creation into tests because
  tox core doesn't need it.

2.2.1

---

• fix bug where {envdir} substitution could not be used in setenv
  if that env value is then used in {basepython}. Thanks Florian Bruhin.

2.2.0

---

• fix issue265 and add LD_LIBRARY_PATH to passenv on linux by default
  because otherwise the python interpreter might not start up in
  certain configurations (redhat software collections). Thanks David Riddle.

• fix issue246: fix regression in config parsing by reordering
  such that {envbindir} can be used again in tox.ini. Thanks Olli Walsh.

• fix issue99: the {env:...} substitution now properly uses environment
  settings from the setenv section. Thanks Itxaka Serrano.

• fix issue281: make --force-dep work when urls are present in
  dependency configs. Thanks Glyph Lefkowitz for reporting.

• fix issue174: add new ignore_outcome testenv attribute which
  can be set to True in which case it will produce a warning instead
  of an error on a failed testenv command outcome.
  Thanks Rebecka Gulliksson for the PR.

• fix issue280: properly skip missing interpreter if
  {envsitepackagesdir} is present in commands. Thanks BB:ceridwenv

coverage 4.0 -> 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:

4.1

---

• The internal attribute Reporter.file_reporters was removed in 4.1b3. It
  should have come has no surprise that there were third-party tools out there
  using that attribute. It has been restored, but with a deprecation warning.

4.1b3

---

• When running your program, execution can jump from an except X: line to
  some other line when an exception other than X happens. This jump is no
  longer considered a branch when measuring branch coverage.

• When measuring branch coverage, yield statements that were never resumed
  were incorrectly marked as missing, as reported in issue 440_. This is now
  fixed.

• During branch coverage of single-line callables like lambdas and generator
  expressions, coverage.py can now distinguish between them never being called,
  or being called but not completed. Fixes issue 90, issue 460 and
  issue 475_.

• The HTML report now has a map of the file along the rightmost edge of the
  page, giving an overview of where the missed lines are. Thanks, Dmitry
  Shishov.

• The HTML report now uses different monospaced fonts, favoring Consolas over
  Courier. Along the way, issue 472_ about not properly handling one-space
  indents was fixed. The index page also has slightly different styling, to
  try to make the clickable detail pages more apparent.

• Missing branches reported with coverage report -m will now say ->exit
  for missed branches to the exit of a function, rather than a negative number.
  Fixes issue 469_.

• coverage --help and coverage --version now mention which tracer is
  installed, to help diagnose problems. The docs mention which features need
  the C extension. (issue 479_)

• Officially support PyPy 5.1, which required no changes, just updates to the
  docs.

• The Coverage.report function had two parameters with non-None defaults,
  which have been changed. show_missing used to default to True, but now
  defaults to None. If you had been calling Coverage.report without
  specifying show_missing, you'll need to explicitly set it to True to keep
  the same behavior. skip_covered used to default to False. It is now None,
  which doesn't change the behavior. This fixes issue 485_.

• It's never been possible to pass a namespace module to one of the analysis
  functions, but now at least we raise a more specific error message, rather
  than getting confused. (issue 456_)

• The coverage.process_startup function now returns the Coverage instance
  it creates, as suggested in issue 481_.

• Make a small tweak to how we compare threads, to avoid buggy custom
  comparison code in thread classes. (issue 245_)

.. _issue 90: https://bitbucket.org/ned/coveragepy/issues/90/lambda-expression-confuses-branch
.. _issue 245: https://bitbucket.org/ned/coveragepy/issues/245/change-solution-for-issue-164
.. _issue 440: https://bitbucket.org/ned/coveragepy/issues/440/yielded-twisted-failure-marked-as-missed
.. _issue 456: https://bitbucket.org/ned/coveragepy/issues/456/coverage-breaks-with-implicit-namespaces
.. _issue 460: htt

[coveralls]

Coverage decreased (-1.1%) to 92.308% when pulling 5960e56 on pyup-initial-update into ec5d9f7 on master.