eric: comparison DebugClients/Python/coverage/doc/CHANGES.txt

-:4ba7a8ab24f2
+:0d8612e24fef
+.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
+.. For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
+==============================
+Change history for Coverage.py
+==============================
+Version 4.0 --- 20 September 2015
+---------------------------------
+No changes from 4.0b3
+Version 4.0b3 --- 7 September 2015
+----------------------------------
+- Reporting on an unmeasured file would fail with a traceback.  This is now
+fixed, closing `issue 403`_.
+- The Jenkins ShiningPanda plugin looks for an obsolete file name to find the
+HTML reports to publish, so it was failing under coverage.py 4.0.  Now we
+create that file if we are running under Jenkins, to keep things working
+smoothly. `issue 404`_.
+- Kits used to include tests and docs, but didn't install them anywhere, or
+provide all of the supporting tools to make them useful.  Kits no longer
+include tests and docs.  If you were using them from the older packages, get
+in touch and help me understand how.
+.. _issue 403: https://bitbucket.org/ned/coveragepy/issues/403/hasherupdate-fails-with-typeerror-nonetype
+.. _issue 404: https://bitbucket.org/ned/coveragepy/issues/404/shiningpanda-jenkins-plugin-cant-find-html
+Version 4.0b2 --- 22 August 2015
+--------------------------------
+- 4.0b1 broke --append creating new data files.  This is now fixed, closing
+`issue 392`_.
+- ``py.test --cov`` can write empty data, then touch files due to ``--source``,
+which made coverage.py mistakenly force the data file to record lines instead
+of arcs.  This would lead to a "Can't combine line data with arc data" error
+message.  This is now fixed, and changed some method names in the
+CoverageData interface.  Fixes `issue 399`_.
+- `CoverageData.read_fileobj` and `CoverageData.write_fileobj` replace the
+`.read` and `.write` methods, and are now properly inverses of each other.
+- When using ``report --skip-covered``, a message will now be included in the
+report output indicating how many files were skipped, and if all files are
+skipped, coverage.py won't accidentally scold you for having no data to
+report.  Thanks, Krystian Kichewko.
+- A new conversion utility has been added:  ``python -m coverage.pickle2json``
+will convert v3.x pickle data files to v4.x JSON data files.  Thanks,
+Alexander Todorov.  Closes `issue 395`_.
+- A new version identifier is available, `coverage.version_info`, a plain tuple
+of values similar to `sys.version_info`_.
+.. _issue 392: https://bitbucket.org/ned/coveragepy/issues/392/run-append-doesnt-create-coverage-file
+.. _issue 395: https://bitbucket.org/ned/coveragepy/issues/395/rfe-read-pickled-files-as-well-for
+.. _issue 399: https://bitbucket.org/ned/coveragepy/issues/399/coverageexception-cant-combine-line-data
+.. _sys.version_info: https://docs.python.org/3/library/sys.html#sys.version_info
+Version 4.0b1 --- 2 August 2015
+-------------------------------
+- Coverage.py is now licensed under the Apache 2.0 license.  See NOTICE.txt for
+details.  Closes `issue 313`_.
+- The data storage has been completely revamped.  The data file is now
+JSON-based instead of a pickle, closing `issue 236`_.  The `CoverageData`
+class is now a public supported documented API to the data file.
+- A new configuration option, ``[run] note``, lets you set a note that will be
+stored in the `runs` section of the data file.  You can use this to annotate
+the data file with any information you like.
+- Unrecognized configuration options will now print an error message and stop
+coverage.py.  This should help prevent configuration mistakes from passing
+silently.  Finishes `issue 386`_.
+- In parallel mode, ``coverage erase`` will now delete all of the data files,
+fixing `issue 262`_.
+- Coverage.py now accepts a directory name for ``coverage run`` and will run a
+``__main__.py`` found there, just like Python will.  Fixes `issue 252`_.
+Thanks, Dmitry Trofimov.
+- The XML report now includes a ``missing-branches`` attribute.  Thanks, Steve
+Peak.  This is not a part of the Cobertura DTD, so the XML report no longer
+references the DTD.
+- Missing branches in the HTML report now have a bit more information in the
+right-hand annotations.  Hopefully this will make their meaning clearer.
+- All the reporting functions now behave the same if no data had been
+collected, exiting with a status code of 1.  Fixed ``fail_under`` to be
+applied even when the report is empty.  Thanks, Ionel Cristian Mărieș.
+- Plugins are now initialized differently.  Instead of looking for a class
+called ``Plugin``, coverage.py looks for a function called ``coverage_init``.
+- A file-tracing plugin can now ask to have built-in Python reporting by
+returning `"python"` from its `file_reporter()` method.
+- Code that was executed with `exec` would be mis-attributed to the file that
+called it.  This is now fixed, closing `issue 380`_.
+- The ability to use item access on `Coverage.config` (introduced in 4.0a2) has
+been changed to a more explicit `Coverage.get_option` and
+`Coverage.set_option` API.
+- The ``Coverage.use_cache`` method is no longer supported.
+- The private method ``Coverage._harvest_data`` is now called
+``Coverage.get_data``, and returns the ``CoverageData`` containing the
+collected data.
+- The project is consistently referred to as "coverage.py" throughout the code
+and the documentation, closing `issue 275`_.
+- Combining data files with an explicit configuration file was broken in 4.0a6,
+but now works again, closing `issue 385`_.
+- ``coverage combine`` now accepts files as well as directories.
+- The speed is back to 3.7.1 levels, after having slowed down due to plugin
+support, finishing up `issue 387`_.
+.. _issue 236: https://bitbucket.org/ned/coveragepy/issues/236/pickles-are-bad-and-you-should-feel-bad
+.. _issue 252: https://bitbucket.org/ned/coveragepy/issues/252/coverage-wont-run-a-program-with
+.. _issue 262: https://bitbucket.org/ned/coveragepy/issues/262/when-parallel-true-erase-should-erase-all
+.. _issue 275: https://bitbucket.org/ned/coveragepy/issues/275/refer-consistently-to-project-as-coverage
+.. _issue 313: https://bitbucket.org/ned/coveragepy/issues/313/add-license-file-containing-2-3-or-4
+.. _issue 380: https://bitbucket.org/ned/coveragepy/issues/380/code-executed-by-exec-excluded-from
+.. _issue 385: https://bitbucket.org/ned/coveragepy/issues/385/coverage-combine-doesnt-work-with-rcfile
+.. _issue 386: https://bitbucket.org/ned/coveragepy/issues/386/error-on-unrecognised-configuration
+.. _issue 387: https://bitbucket.org/ned/coveragepy/issues/387/performance-degradation-from-371-to-40
+.. 40 issues closed in 4.0 below here
+Version 4.0a6 --- 21 June 2015
 ------------------------------
-Change history for Coverage.py
-------------------------------
+- Python 3.5b2 and PyPy 2.6.0 are supported.
-3.7.1 -- 13 December 2013
+- The original module-level function interface to coverage.py is no longer
--------------------------
+supported.  You must now create a ``coverage.Coverage`` object, and use
+methods on it.
+- The ``coverage combine`` command now accepts any number of directories as
+arguments, and will combine all the data files from those directories.  This
+means you don't have to copy the files to one directory before combining.
+Thanks, Christine Lytwynec.  Finishes `issue 354`_.
+- Branch coverage couldn't properly handle certain extremely long files. This
+is now fixed (`issue 359`_).
+- Branch coverage didn't understand yield statements properly.  Mickie Betz
+persisted in pursuing this despite Ned's pessimism.  Fixes `issue 308`_ and
+`issue 324`_.
+- The COVERAGE_DEBUG environment variable can be used to set the ``[run] debug``
+configuration option to control what internal operations are logged.
+- HTML reports were truncated at formfeed characters.  This is now fixed
+(`issue 360`_).  It's always fun when the problem is due to a `bug in the
+Python standard library <http://bugs.python.org/issue19035>`_.
+- Files with incorrect encoding declaration comments are no longer ignored by
+the reporting commands, fixing `issue 351`_.
+- HTML reports now include a timestamp in the footer, closing `issue 299`_.
+Thanks, Conrad Ho.
+- HTML reports now begrudgingly use double-quotes rather than single quotes,
+because there are "software engineers" out there writing tools that read HTML
+and somehow have no idea that single quotes exist.  Capitulates to the absurd
+`issue 361`_.  Thanks, Jon Chappell.
+- The ``coverage annotate`` command now handles non-ASCII characters properly,
+closing `issue 363`_.  Thanks, Leonardo Pistone.
+- Drive letters on Windows were not normalized correctly, now they are. Thanks,
+Ionel Cristian Mărieș.
+- Plugin support had some bugs fixed, closing `issue 374`_ and `issue 375`_.
+Thanks, Stefan Behnel.
+.. _issue 299: https://bitbucket.org/ned/coveragepy/issue/299/inserted-created-on-yyyy-mm-dd-hh-mm-in
+.. _issue 308: https://bitbucket.org/ned/coveragepy/issue/308/yield-lambda-branch-coverage
+.. _issue 324: https://bitbucket.org/ned/coveragepy/issue/324/yield-in-loop-confuses-branch-coverage
+.. _issue 351: https://bitbucket.org/ned/coveragepy/issue/351/files-with-incorrect-encoding-are-ignored
+.. _issue 354: https://bitbucket.org/ned/coveragepy/issue/354/coverage-combine-should-take-a-list-of
+.. _issue 359: https://bitbucket.org/ned/coveragepy/issue/359/xml-report-chunk-error
+.. _issue 360: https://bitbucket.org/ned/coveragepy/issue/360/html-reports-get-confused-by-l-in-the-code
+.. _issue 361: https://bitbucket.org/ned/coveragepy/issue/361/use-double-quotes-in-html-output-to
+.. _issue 363: https://bitbucket.org/ned/coveragepy/issue/363/annotate-command-hits-unicode-happy-fun
+.. _issue 374: https://bitbucket.org/ned/coveragepy/issue/374/c-tracer-lookups-fail-in
+.. _issue 375: https://bitbucket.org/ned/coveragepy/issue/375/ctracer_handle_return-reads-byte-code
+Version 4.0a5 --- 16 February 2015
+----------------------------------
+- Plugin support is now implemented in the C tracer instead of the Python
+tracer. This greatly improves the speed of tracing projects using plugins.
+- Coverage.py now always adds the current directory to sys.path, so that
+plugins can import files in the current directory (`issue 358`_).
+- If the `config_file` argument to the Coverage constructor is specified as
+".coveragerc", it is treated as if it were True.  This means setup.cfg is
+also examined, and a missing file is not considered an error (`issue 357`_).
+- Wildly experimental: support for measuring processes started by the
+multiprocessing module.  To use, set ``--concurrency=multiprocessing``,
+either on the command line or in the .coveragerc file (`issue 117`_). Thanks,
+Eduardo Schettino.  Currently, this does not work on Windows.
+- A new warning is possible, if a desired file isn't measured because it was
+imported before coverage.py was started (`issue 353`_).
+- The `coverage.process_startup` function now will start coverage measurement
+only once, no matter how many times it is called.  This fixes problems due
+to unusual virtualenv configurations (`issue 340`_).
+- Added 3.5.0a1 to the list of supported CPython versions.
+.. _issue 117: https://bitbucket.org/ned/coveragepy/issue/117/enable-coverage-measurement-of-code-run-by
+.. _issue 340: https://bitbucket.org/ned/coveragepy/issue/340/keyerror-subpy
+.. _issue 353: https://bitbucket.org/ned/coveragepy/issue/353/40a3-introduces-an-unexpected-third-case
+.. _issue 357: https://bitbucket.org/ned/coveragepy/issue/357/behavior-changed-when-coveragerc-is
+.. _issue 358: https://bitbucket.org/ned/coveragepy/issue/358/all-coverage-commands-should-adjust
+Version 4.0a4 --- 25 January 2015
+---------------------------------
+- Plugins can now provide sys_info for debugging output.
+- Started plugins documentation.
+- Prepared to move the docs to readthedocs.org.
+Version 4.0a3 --- 20 January 2015
+---------------------------------
+- Reports now use file names with extensions.  Previously, a report would
+describe a/b/c.py as "a/b/c".  Now it is shown as "a/b/c.py".  This allows
+for better support of non-Python files, and also fixed `issue 69`_.
+- The XML report now reports each directory as a package again.  This was a bad
+regression, I apologize.  This was reported in `issue 235`_, which is now
+fixed.
+- A new configuration option for the XML report: ``[xml] package_depth``
+controls which directories are identified as packages in the report.
+Directories deeper than this depth are not reported as packages.
+The default is that all directories are reported as packages.
+Thanks, Lex Berezhny.
+- When looking for the source for a frame, check if the file exists. On
+Windows, .pyw files are no longer recorded as .py files. Along the way, this
+fixed `issue 290`_.
+- Empty files are now reported as 100% covered in the XML report, not 0%
+covered (`issue 345`_).
+- Regexes in the configuration file are now compiled as soon as they are read,
+to provide error messages earlier (`issue 349`_).
+.. _issue 69: https://bitbucket.org/ned/coveragepy/issue/69/coverage-html-overwrite-files-that-doesnt
+.. _issue 235: https://bitbucket.org/ned/coveragepy/issue/235/package-name-is-missing-in-xml-report
+.. _issue 290: https://bitbucket.org/ned/coveragepy/issue/290/running-programmatically-with-pyw-files
+.. _issue 345: https://bitbucket.org/ned/coveragepy/issue/345/xml-reports-line-rate-0-for-empty-files
+.. _issue 349: https://bitbucket.org/ned/coveragepy/issue/349/bad-regex-in-config-should-get-an-earlier
+Version 4.0a2 --- 14 January 2015
+---------------------------------
+- Officially support PyPy 2.4, and PyPy3 2.4.  Drop support for
+CPython 3.2 and older versions of PyPy.  The code won't work on CPython 3.2.
+It will probably still work on older versions of PyPy, but I'm not testing
+against them.
+- Plugins!
+- The original command line switches (`-x` to run a program, etc) are no
+longer supported.
+- A new option: `coverage report --skip-covered` will reduce the number of
+files reported by skipping files with 100% coverage.  Thanks, Krystian
+Kichewko.  This means that empty `__init__.py` files will be skipped, since
+they are 100% covered, closing `issue 315`_.
+- You can now specify the ``--fail-under`` option in the ``.coveragerc`` file
+as the ``[report] fail_under`` option.  This closes `issue 314`_.
+- The ``COVERAGE_OPTIONS`` environment variable is no longer supported.  It was
+a hack for ``--timid`` before configuration files were available.
+- The HTML report now has filtering.  Type text into the Filter box on the
+index page, and only modules with that text in the name will be shown.
+Thanks, Danny Allen.
+- The textual report and the HTML report used to report partial branches
+differently for no good reason.  Now the text report's "missing branches"
+column is a "partial branches" column so that both reports show the same
+numbers.  This closes `issue 342`_.
+- If you specify a ``--rcfile`` that cannot be read, you will get an error
+message.  Fixes `issue 343`_.
+- The ``--debug`` switch can now be used on any command.
+- You can now programmatically adjust the configuration of coverage.py by
+setting items on `Coverage.config` after construction.
+- A module run with ``-m`` can be used as the argument to ``--source``, fixing
+`issue 328`_.  Thanks, Buck Evan.
+- The regex for matching exclusion pragmas has been fixed to allow more kinds
+of whitespace, fixing `issue 334`_.
+- Made some PyPy-specific tweaks to improve speed under PyPy.  Thanks, Alex
+Gaynor.
+- In some cases, with a source file missing a final newline, coverage.py would
+count statements incorrectly.  This is now fixed, closing `issue 293`_.
+- The status.dat file that HTML reports use to avoid re-creating files that
+haven't changed is now a JSON file instead of a pickle file.  This obviates
+`issue 287`_ and `issue 237`_.
+.. _issue 237: https://bitbucket.org/ned/coveragepy/issue/237/htmlcov-with-corrupt-statusdat
+.. _issue 287: https://bitbucket.org/ned/coveragepy/issue/287/htmlpy-doesnt-specify-pickle-protocol
+.. _issue 293: https://bitbucket.org/ned/coveragepy/issue/293/number-of-statement-detection-wrong-if-no
+.. _issue 314: https://bitbucket.org/ned/coveragepy/issue/314/fail_under-param-not-working-in-coveragerc
+.. _issue 315: https://bitbucket.org/ned/coveragepy/issue/315/option-to-omit-empty-files-eg-__init__py
+.. _issue 328: https://bitbucket.org/ned/coveragepy/issue/328/misbehavior-in-run-source
+.. _issue 334: https://bitbucket.org/ned/coveragepy/issue/334/pragma-not-recognized-if-tab-character
+.. _issue 342: https://bitbucket.org/ned/coveragepy/issue/342/console-and-html-coverage-reports-differ
+.. _issue 343: https://bitbucket.org/ned/coveragepy/issue/343/an-explicitly-named-non-existent-config
+Version 4.0a1 --- 27 September 2014
+-----------------------------------
+- Python versions supported are now CPython 2.6, 2.7, 3.2, 3.3, and 3.4, and
+PyPy 2.2.
+- Gevent, eventlet, and greenlet are now supported, closing `issue 149`_.
+The ``concurrency`` setting specifies the concurrency library in use.  Huge
+thanks to Peter Portante for initial implementation, and to Joe Jevnik for
+the final insight that completed the work.
+- Options are now also read from a setup.cfg file, if any.  Sections are
+prefixed with "coverage:", so the ``[run]`` options will be read from the
+``[coverage:run]`` section of setup.cfg.  Finishes `issue 304`_.
+- The ``report -m`` command can now show missing branches when reporting on
+branch coverage.  Thanks, Steve Leonard. Closes `issue 230`_.
+- The XML report now contains a <source> element, fixing `issue 94`_.  Thanks
+Stan Hu.
+- The class defined in the coverage module is now called ``Coverage`` instead
+of ``coverage``, though the old name still works, for backward compatibility.
+- The ``fail-under`` value is now rounded the same as reported results,
+preventing paradoxical results, fixing `issue 284`_.
+- The XML report will now create the output directory if need be, fixing
+`issue 285`_.  Thanks, Chris Rose.
+- HTML reports no longer raise UnicodeDecodeError if a Python file has
+undecodable characters, fixing `issue 303`_ and `issue 331`_.
+- The annotate command will now annotate all files, not just ones relative to
+the current directory, fixing `issue 57`_.
+- The coverage module no longer causes deprecation warnings on Python 3.4 by
+importing the imp module, fixing `issue 305`_.
+- Encoding declarations in source files are only considered if they are truly
+comments.  Thanks, Anthony Sottile.
+.. _issue 57: https://bitbucket.org/ned/coveragepy/issue/57/annotate-command-fails-to-annotate-many
+.. _issue 94: https://bitbucket.org/ned/coveragepy/issue/94/coverage-xml-doesnt-produce-sources
+.. _issue 149: https://bitbucket.org/ned/coveragepy/issue/149/coverage-gevent-looks-broken
+.. _issue 230: https://bitbucket.org/ned/coveragepy/issue/230/show-line-no-for-missing-branches-in
+.. _issue 284: https://bitbucket.org/ned/coveragepy/issue/284/fail-under-should-show-more-precision
+.. _issue 285: https://bitbucket.org/ned/coveragepy/issue/285/xml-report-fails-if-output-file-directory
+.. _issue 303: https://bitbucket.org/ned/coveragepy/issue/303/unicodedecodeerror
+.. _issue 304: https://bitbucket.org/ned/coveragepy/issue/304/attempt-to-get-configuration-from-setupcfg
+.. _issue 305: https://bitbucket.org/ned/coveragepy/issue/305/pendingdeprecationwarning-the-imp-module
+.. _issue 331: https://bitbucket.org/ned/coveragepy/issue/331/failure-of-encoding-detection-on-python2
+Version 3.7.1 --- 13 December 2013
+----------------------------------
 - Improved the speed of HTML report generation by about 20%.
 - Fixed the mechanism for finding OS-installed static files for the HTML report
 so that it will actually find OS-installed static files.
-3.7 --- 6 October 2013
+Version 3.7 --- 6 October 2013
-----------------------
+------------------------------
 - Added the ``--debug`` switch to ``coverage run``.  It accepts a list of
 options indicating the type of internal activity to log to stderr.
 - Improved the branch coverage facility, fixing `issue 92`_ and `issue 175`_.
 - Running code with ``coverage run -m`` now behaves more like Python does,
 setting sys.path properly, which fixes `issue 207`_ and `issue 242`_.
-- Coverage can now run .pyc files directly, closing `issue 264`_.
+- Coverage.py can now run .pyc files directly, closing `issue 264`_.
-- Coverage properly supports .pyw files, fixing `issue 261`_.
+- Coverage.py properly supports .pyw files, fixing `issue 261`_.
 - Omitting files within a tree specified with the ``source`` option would
 cause them to be incorrectly marked as unexecuted, as described in
 `issue 218`_.  This is now fixed.
 (``build/$BUILDNUM/src``).
 - Trying to create an XML report with no files to report on, would cause a
 ZeroDivideError, but no longer does, fixing `issue 250`_.
-- When running a threaded program under the Python tracer, coverage no longer
+- When running a threaded program under the Python tracer, coverage.py no
-issues a spurious warning about the trace function changing: "Trace function
+longer issues a spurious warning about the trace function changing: "Trace
-changed, measurement is likely wrong: None."  This fixes `issue 164`_.
+function changed, measurement is likely wrong: None."  This fixes `issue
+164`_.
 - Static files necessary for HTML reports are found in system-installed places,
 to ease OS-level packaging of coverage.py.  Closes `issue 259`_.
 - Source files with encoding declarations, but a blank first line, were not
 ``source`` and path aliases.  It no longer does.
 - ``debug sys`` now shows the configuration file path that was read.
 - If an oddly-behaved package claims that code came from an empty-string
-filename, coverage.py no longer associates it with the directory name,
+file name, coverage.py no longer associates it with the directory name,
 fixing `issue 221`_.
 .. _issue 80: https://bitbucket.org/ned/coveragepy/issue/80/is-there-a-duck-typing-way-to-know-we-cant
 .. _issue 221: https://bitbucket.org/ned/coveragepy/issue/221/coveragepy-incompatible-with-pyratemp
 ``--title`` switch on the command line, or via the API.
 - Configuration files now support substitution of environment variables, using
 syntax like ``${WORD}``.  Closes `issue 97`_.
-- Embarrassingly, the `[xml] output=` setting in the .coveragerc file simply
+- Embarrassingly, the ``[xml] output=`` setting in the .coveragerc file simply
 didn't work.  Now it does.
-- The XML report now consistently uses filenames for the filename attribute,
+- The XML report now consistently uses file names for the file name attribute,
 rather than sometimes using module names.  Fixes `issue 67`_.
 Thanks, Marcus Cobden.
 - Coverage percentage metrics are now computed slightly differently under
 branch coverage.  This means that completely unexecuted files will now
 - If `coverage xml` fails because there is no data to report, it used to
 create a zero-length XML file.  Now it doesn't, fixing `issue 210`_.
 - Jython files now work with the ``--source`` option, fixing `issue 100`_.
-- Running coverage under a debugger is unlikely to work, but it shouldn't fail
+- Running coverage.py under a debugger is unlikely to work, but it shouldn't
-with "TypeError: 'NoneType' object is not iterable".  Fixes `issue 201`_.
+fail with "TypeError: 'NoneType' object is not iterable".  Fixes `issue
+201`_.
 - On some Linux distributions, when installed with the OS package manager,
 coverage.py would report its own code as part of the results.  Now it won't,
 fixing `issue 214`_, though this will take some time to be repackaged by the
 operating systems.
 - Docstrings for the legacy singleton methods are more helpful.  Thanks Marius
 Gedminas.  Closes `issue 205`_.
-- The pydoc tool can now show docmentation for the class `coverage.coverage`.
+- The pydoc tool can now show documentation for the class `coverage.coverage`.
 Closes `issue 206`_.
 - Added a page to the docs about contributing to coverage.py, closing
 `issue 171`_.
 ``'NoneType' object has no attribute 'isabs'``.  It no longer does,
 so kiss `issue 153`_ goodbye.
 .. _issue 60: https://bitbucket.org/ned/coveragepy/issue/60/incorrect-path-to-orphaned-pyc-files
 .. _issue 67: https://bitbucket.org/ned/coveragepy/issue/67/xml-report-filenames-may-be-generated
-.. _issue 82: https://bitbucket.org/ned/coveragepy/issue/82/tokenerror-when-generating-html-report
 .. _issue 89: https://bitbucket.org/ned/coveragepy/issue/89/on-windows-all-packages-are-reported-in
 .. _issue 97: https://bitbucket.org/ned/coveragepy/issue/97/allow-environment-variables-to-be
 .. _issue 100: https://bitbucket.org/ned/coveragepy/issue/100/source-directive-doesnt-work-for-packages
 .. _issue 111: https://bitbucket.org/ned/coveragepy/issue/111/when-installing-coverage-with-pip-not
 .. _issue 137: https://bitbucket.org/ned/coveragepy/issue/137/provide-docs-with-source-distribution
 - Line numbers in the HTML report line up better with the source lines, fixing
 `issue 197`_, thanks Marius Gedminas.
 - When specifying a directory as the source= option, the directory itself no
-longer needs to have a ``__init__.py`` file, though its subdirectories do, to
+longer needs to have a ``__init__.py`` file, though its sub-directories do,
-be considered as source files.
+to be considered as source files.
 - Files encoded as UTF-8 with a BOM are now properly handled, fixing
 `issue 179`_.  Thanks, Pablo Carballo.
 - Fixed more cases of non-Python files being reported as Python source, and
 - Try to do a better job of the impossible task of detecting when we can't
 build the C extension, fixing `issue 183`_.
 - Testing is now done with `tox`_, thanks, Marc Abramowitz.
-.. _issue 82: https://bitbucket.org/ned/coveragepy/issue/82/tokenerror-when-generating-html-report
 .. _issue 147: https://bitbucket.org/ned/coveragepy/issue/147/massive-memory-usage-by-ctracer
 .. _issue 179: https://bitbucket.org/ned/coveragepy/issue/179/htmlreporter-fails-when-source-file-is
 .. _issue 183: https://bitbucket.org/ned/coveragepy/issue/183/install-fails-for-python-23
 .. _issue 194: https://bitbucket.org/ned/coveragepy/issue/194/filelocatorrelative_filename-could-mangle
 .. _issue 195: https://bitbucket.org/ned/coveragepy/issue/195/pyo-file-handling-in-codeunit
 .. _issue 197: https://bitbucket.org/ned/coveragepy/issue/197/line-numbers-in-html-report-do-not-align
 .. _tox: http://tox.readthedocs.org/
 Version 3.5.2 --- 4 May 2012
 ----------------------------
 No changes since 3.5.2.b1
 - The HTML report has slightly tweaked controls: the buttons at the top of
 the page are color-coded to the source lines they affect.
 - Custom CSS can be applied to the HTML report by specifying a CSS file as
-the extra_css configuration value in the [html] section.
+the ``extra_css`` configuration value in the ``[html]`` section.
 - Source files with custom encodings declared in a comment at the top are now
 properly handled during reporting on Python 2.  Python 3 always handled them
 properly.  This fixes `issue 157`_.
 - Backup files left behind by editors are no longer collected by the source=
 option, fixing `issue 168`_.
 - If a file doesn't parse properly as Python, we don't report it as an error
-if the filename seems like maybe it wasn't meant to be Python.  This is a
+if the file name seems like maybe it wasn't meant to be Python.  This is a
 pragmatic fix for `issue 82`_.
 - The ``-m`` switch on ``coverage report``, which includes missing line numbers
-in the summary report, can now be specifed as ``show_missing`` in the
+in the summary report, can now be specified as ``show_missing`` in the
 config file.  Closes `issue 173`_.
 - When running a module with ``coverage run -m <modulename>``, certain details
 of the execution environment weren't the same as for
 ``python -m <modulename>``.  This had the unfortunate side-effect of making
 status when running ``python -m coverage run ...``.  Thanks, JT Olds.
 - When installing into pypy, we no longer attempt (and fail) to compile
 the C tracer function, closing `issue 166`_.
-.. _issue 82: https://bitbucket.org/ned/coveragepy/issue/82/tokenerror-when-generating-html-report
 .. _issue 142: https://bitbucket.org/ned/coveragepy/issue/142/executing-python-file-syspath-is-replaced
 .. _issue 155: https://bitbucket.org/ned/coveragepy/issue/155/cant-use-coverage-run-m-unittest-discover
 .. _issue 157: https://bitbucket.org/ned/coveragepy/issue/157/chokes-on-source-files-with-non-utf-8
 .. _issue 166: https://bitbucket.org/ned/coveragepy/issue/166/dont-try-to-compile-c-extension-on-pypy
 .. _issue 168: https://bitbucket.org/ned/coveragepy/issue/168/dont-be-alarmed-by-emacs-droppings
 Version 3.5.1b1 --- 28 August 2011
 ----------------------------------
-- When combining data files from parallel runs, you can now instruct coverage
+- When combining data files from parallel runs, you can now instruct
-about which directories are equivalent on different machines.  A ``[paths]``
+coverage.py about which directories are equivalent on different machines.  A
-section in the configuration file lists paths that are to be considered
+``[paths]`` section in the configuration file lists paths that are to be
-equivalent.  Finishes `issue 17`_.
+considered equivalent.  Finishes `issue 17`_.
 - for-else constructs are understood better, and don't cause erroneous partial
 branch warnings.  Fixes `issue 122`_.
 - Branch coverage for ``with`` statements is improved, fixing `issue 128`_.
 different than the number reported on the individual file pages.  This is
 now fixed.
 - An explicit include directive to measure files in the Python installation
 wouldn't work because of the standard library exclusion.  Now the include
-directive takes precendence, and the files will be measured.  Fixes
+directive takes precedence, and the files will be measured.  Fixes
 `issue 138`_.
 - The HTML report now handles Unicode characters in Python source files
 properly.  This fixes `issue 124`_ and `issue 144`_. Thanks, Devin
 Jeanpierre.
 - In order to help the core developers measure the test coverage of the
 standard library, Brandon Rhodes devised an aggressive hack to trick Python
-into running some coverage code before anything else in the process.
+into running some coverage.py code before anything else in the process.
 See the coverage/fullcoverage directory if you are interested.
 .. _issue 17: http://bitbucket.org/ned/coveragepy/issue/17/support-combining-coverage-data-from
 .. _issue 122: http://bitbucket.org/ned/coveragepy/issue/122/for-else-always-reports-missing-branch
 .. _issue 124: http://bitbucket.org/ned/coveragepy/issue/124/no-arbitrary-unicode-in-html-reports-in
 - BACKWARD INCOMPATIBILITY: the ``--omit`` and ``--include`` switches now take
 file patterns rather than file prefixes, closing `issue 34`_ and `issue 36`_.
 - BACKWARD INCOMPATIBILITY: the `omit_prefixes` argument is gone throughout
-coverage.py, replaced with `omit`, a list of filename patterns suitable for
+coverage.py, replaced with `omit`, a list of file name patterns suitable for
 `fnmatch`.  A parallel argument `include` controls what files are included.
 - The run command now has a ``--source`` switch, a list of directories or
 module names.  If provided, coverage.py will only measure execution in those
 source files.
 - Programs that call ``os.fork`` will properly collect data from both the child
 and parent processes.  Use ``coverage run -p`` to get two data files that can
 be combined with ``coverage combine``.  Fixes `issue 56`_.
-- Coverage is now runnable as a module: ``python -m coverage``.  Thanks,
+- Coverage.py is now runnable as a module: ``python -m coverage``.  Thanks,
 Brett Cannon.
 - When measuring code running in a virtualenv, most of the system library was
 being measured when it shouldn't have been.  This is now fixed.
 - Doctest text files are no longer recorded in the coverage data, since they
 can't be reported anyway.  Fixes `issue 52`_ and `issue 61`_.
-- Jinja HTML templates compile into Python code using the HTML filename,
+- Jinja HTML templates compile into Python code using the HTML file name,
 which confused coverage.py.  Now these files are no longer traced, fixing
 `issue 82`_.
 - Source files can have more than one dot in them (foo.test.py), and will be
 treated properly while reporting.  Fixes `issue 46`_.
 - On Python 2.3, coverage.py could mis-measure code with exceptions being
 raised.  This is now fixed.
 - The coverage.py code itself will now not be measured by coverage.py, and no
-coverage modules will be mentioned in the nose --with-cover plug-in.  Fixed
+coverage.py modules will be mentioned in the nose --with-cover plug-in.
-`issue 8`_.
+Fixed `issue 8`_.
 - When running source files, coverage.py now opens them in universal newline
 mode just like Python does.  This lets it run Windows files on Mac, for
 example.
 Version 3.0b1 --- 7 March 2009
 ------------------------------
 Major overhaul.
-- Coverage is now a package rather than a module.  Functionality has been split
+- Coverage.py is now a package rather than a module.  Functionality has been
-into classes.
+split into classes.
-- The trace function is implemented in C for speed.  Coverage runs are now
+- The trace function is implemented in C for speed.  Coverage.py runs are now
 much faster.  Thanks to David Christian for productive micro-sprints and
 other encouragement.
 - Executable lines are identified by reading the line number tables in the
 compiled code, removing a great deal of complicated analysis code.
 - Precisely which lines are considered executable has changed in some cases.
 Therefore, your coverage stats may also change slightly.
 - The singleton coverage object is only created if the module-level functions
 are used.  This maintains the old interface while allowing better
-programmatic use of Coverage.
+programmatic use of Coverage.py.
 - The minimum supported Python version is 2.3.
 Version 2.85 --- 14 September 2008
 Fuzzey.
 - Add a file argument to report so that reports can be captured to a different
 destination.
-- coverage.py can now measure itself.
+- Coverage.py can now measure itself.
 - Adapted Greg Rogers' patch for using relative file names, and sorting and
 omitting files to report on.

Mercurial Repositories > eric / file comparison

comparison: DebugClients/Python/coverage/doc/CHANGES.txt

DebugClients/Python/coverage/doc/CHANGES.txt