From 5428c27d6d592d71d37696c92c3c8fc12beb413f Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 11 Oct 2021 17:44:01 -0400 Subject: [PATCH 001/137] build: bump version --- CHANGES.rst | 6 ++++++ coverage/version.py | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 12f15d81a..8af94282b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -20,6 +20,12 @@ This list is detailed and covers changes in each pre-release version. .. ---------------------------- +Unreleased +---------- + +Nothing yet. + + .. _changes_602: Version 6.0.2 --- 2021-10-11 diff --git a/coverage/version.py b/coverage/version.py index 8bc98ac60..8aa3bcf72 100644 --- a/coverage/version.py +++ b/coverage/version.py @@ -5,7 +5,7 @@ # This file is exec'ed in setup.py, don't import anything! # Same semantics as sys.version_info. -version_info = (6, 0, 2, "final", 0) +version_info = (6, 0, 3, "alpha", 0) def _make_version(major, minor, micro, releaselevel, serial): From d4434d1b2b042cb60d998cf835aec4d3bfa9be39 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 11 Oct 2021 19:24:07 -0400 Subject: [PATCH 002/137] docs: keep CHANGES small, full list is in the docs --- CHANGES.rst | 2784 +--------------------------------------------- doc/changes.rst | 2834 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 2839 insertions(+), 2779 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 8af94282b..20aab53d9 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -307,2785 +307,11 @@ Version 5.3 --- 2020-09-13 .. _issue 1011: https://github.com/nedbat/coveragepy/issues/1011 -.. _changes_521: +.. endchangesinclude -Version 5.2.1 --- 2020-07-23 ----------------------------- - -- The dark mode HTML report still used light colors for the context listing, - making them unreadable (`issue 1009`_). This is now fixed. - -- The time stamp on the HTML report now includes the time zone. Thanks, Xie - Yanbo (`pull request 960`_). - -.. _pull request 960: https://github.com/nedbat/coveragepy/pull/960 -.. _issue 1009: https://github.com/nedbat/coveragepy/issues/1009 - - -.. _changes_52: - -Version 5.2 --- 2020-07-05 --------------------------- - -- The HTML report has been redesigned by Vince Salvino. There is now a dark - mode, the code text is larger, and system sans serif fonts are used, in - addition to other small changes (`issue 858`_ and `pull request 931`_). - -- The ``coverage report`` and ``coverage html`` commands now accept a - ``--precision`` option to control the number of decimal points displayed. - Thanks, Teake Nutma (`pull request 982`_). - -- The ``coverage report`` and ``coverage html`` commands now accept a - ``--no-skip-covered`` option to negate ``--skip-covered``. Thanks, Anthony - Sottile (`issue 779`_ and `pull request 932`_). - -- The ``--skip-empty`` option is now available for the XML report, closing - `issue 976`_. - -- The ``coverage report`` command now accepts a ``--sort`` option to specify - how to sort the results. Thanks, Jerin Peter George (`pull request 1005`_). - -- If coverage fails due to the coverage total not reaching the ``--fail-under`` - value, it will now print a message making the condition clear. Thanks, - Naveen Yadav (`pull request 977`_). - -- TOML configuration files with non-ASCII characters would cause errors on - Windows (`issue 990`_). This is now fixed. - -- The output of ``--debug=trace`` now includes information about how the - ``--source`` option is being interpreted, and the module names being - considered. - -.. _pull request 931: https://github.com/nedbat/coveragepy/pull/931 -.. _pull request 932: https://github.com/nedbat/coveragepy/pull/932 -.. _pull request 977: https://github.com/nedbat/coveragepy/pull/977 -.. _pull request 982: https://github.com/nedbat/coveragepy/pull/982 -.. _pull request 1005: https://github.com/nedbat/coveragepy/pull/1005 -.. _issue 779: https://github.com/nedbat/coveragepy/issues/779 -.. _issue 858: https://github.com/nedbat/coveragepy/issues/858 -.. _issue 976: https://github.com/nedbat/coveragepy/issues/976 -.. _issue 990: https://github.com/nedbat/coveragepy/issues/990 - - -.. _changes_51: - -Version 5.1 --- 2020-04-12 --------------------------- - -- The JSON report now includes counts of covered and missing branches. Thanks, - Salvatore Zagaria. - -- On Python 3.8, try-finally-return reported wrong branch coverage with - decorated async functions (`issue 964`_). This is now fixed. Thanks, Kjell - Braden. - -- The :meth:`~coverage.Coverage.get_option` and - :meth:`~coverage.Coverage.set_option` methods can now manipulate the - ``[paths]`` configuration setting. Thanks to Bernát Gábor for the fix for - `issue 967`_. - -.. _issue 964: https://github.com/nedbat/coveragepy/issues/964 -.. _issue 967: https://github.com/nedbat/coveragepy/issues/967 - - -.. _changes_504: - -Version 5.0.4 --- 2020-03-16 ----------------------------- - -- If using the ``[run] relative_files`` setting, the XML report will use - relative files in the ```` elements indicating the location of source - code. Closes `issue 948`_. - -- The textual summary report could report missing lines with negative line - numbers on PyPy3 7.1 (`issue 943`_). This is now fixed. - -- Windows wheels for Python 3.8 were incorrectly built, but are now fixed. - (`issue 949`_) - -- Updated Python 3.9 support to 3.9a4. - -- HTML reports couldn't be sorted if localStorage wasn't available. This is now - fixed: sorting works even though the sorting setting isn't retained. (`issue - 944`_ and `pull request 945`_). Thanks, Abdeali Kothari. - -.. _issue 943: https://github.com/nedbat/coveragepy/issues/943 -.. _issue 944: https://github.com/nedbat/coveragepy/issues/944 -.. _pull request 945: https://github.com/nedbat/coveragepy/pull/945 -.. _issue 948: https://github.com/nedbat/coveragepy/issues/948 -.. _issue 949: https://github.com/nedbat/coveragepy/issues/949 - - -.. _changes_503: - -Version 5.0.3 --- 2020-01-12 ----------------------------- - -- A performance improvement in 5.0.2 didn't work for test suites that changed - directory before combining data, causing "Couldn't use data file: no such - table: meta" errors (`issue 916`_). This is now fixed. - -- Coverage could fail to run your program with some form of "ModuleNotFound" or - "ImportError" trying to import from the current directory. This would happen - if coverage had been packaged into a zip file (for example, on Windows), or - was found indirectly (for example, by pyenv-virtualenv). A number of - different scenarios were described in `issue 862`_ which is now fixed. Huge - thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and - George-Cristian Bîrzan for protracted debugging sessions. - -- Added the "premain" debug option. - -- Added SQLite compile-time options to the "debug sys" output. - -.. _issue 862: https://github.com/nedbat/coveragepy/issues/862 -.. _issue 916: https://github.com/nedbat/coveragepy/issues/916 - - -.. _changes_502: - -Version 5.0.2 --- 2020-01-05 ----------------------------- - -- Programs that used multiprocessing and changed directories would fail under - coverage. This is now fixed (`issue 890`_). A side effect is that debug - information about the config files read now shows absolute paths to the - files. - -- When running programs as modules (``coverage run -m``) with ``--source``, - some measured modules were imported before coverage starts. This resulted in - unwanted warnings ("Already imported a file that will be measured") and a - reduction in coverage totals (`issue 909`_). This is now fixed. - -- If no data was collected, an exception about "No data to report" could happen - instead of a 0% report being created (`issue 884`_). This is now fixed. - -- The handling of source files with non-encodable file names has changed. - Previously, if a file name could not be encoded as UTF-8, an error occurred, - as described in `issue 891`_. Now, those files will not be measured, since - their data would not be recordable. - -- A new warning ("dynamic-conflict") is issued if two mechanisms are trying to - change the dynamic context. Closes `issue 901`_. - -- ``coverage run --debug=sys`` would fail with an AttributeError. This is now - fixed (`issue 907`_). - -.. _issue 884: https://github.com/nedbat/coveragepy/issues/884 -.. _issue 890: https://github.com/nedbat/coveragepy/issues/890 -.. _issue 891: https://github.com/nedbat/coveragepy/issues/891 -.. _issue 901: https://github.com/nedbat/coveragepy/issues/901 -.. _issue 907: https://github.com/nedbat/coveragepy/issues/907 -.. _issue 909: https://github.com/nedbat/coveragepy/issues/909 - - -.. _changes_501: - -Version 5.0.1 --- 2019-12-22 ----------------------------- - -- If a 4.x data file is the cause of a "file is not a database" error, then use - a more specific error message, "Looks like a coverage 4.x data file, are you - mixing versions of coverage?" Helps diagnose the problems described in - `issue 886`_. - -- Measurement contexts and relative file names didn't work together, as - reported in `issue 899`_ and `issue 900`_. This is now fixed, thanks to - David Szotten. - -- When using ``coverage run --concurrency=multiprocessing``, all data files - should be named with parallel-ready suffixes. 5.0 mistakenly named the main - process' file with no suffix when using ``--append``. This is now fixed, - closing `issue 880`_. - -- Fixed a problem on Windows when the current directory is changed to a - different drive (`issue 895`_). Thanks, Olivier Grisel. - -- Updated Python 3.9 support to 3.9a2. - -.. _issue 880: https://github.com/nedbat/coveragepy/issues/880 -.. _issue 886: https://github.com/nedbat/coveragepy/issues/886 -.. _issue 895: https://github.com/nedbat/coveragepy/issues/895 -.. _issue 899: https://github.com/nedbat/coveragepy/issues/899 -.. _issue 900: https://github.com/nedbat/coveragepy/issues/900 - - -.. _changes_50: - -Version 5.0 --- 2019-12-14 --------------------------- - -Nothing new beyond 5.0b2. - -A summary of major changes in 5.0 since 4.5.x is in see :ref:`whatsnew5x`. - - - -.. _changes_50b2: - -Version 5.0b2 --- 2019-12-08 ----------------------------- - -- An experimental ``[run] relative_files`` setting tells coverage to store - relative file names in the data file. This makes it easier to run tests in - one (or many) environments, and then report in another. It has not had much - real-world testing, so it may change in incompatible ways in the future. - -- When constructing a :class:`coverage.Coverage` object, `data_file` can be - specified as None to prevent writing any data file at all. In previous - versions, an explicit `data_file=None` argument would use the default of - ".coverage". Fixes `issue 871`_. - -- Python files run with ``-m`` now have ``__spec__`` defined properly. This - fixes `issue 745`_ (about not being able to run unittest tests that spawn - subprocesses), and `issue 838`_, which described the problem directly. - -- The ``[paths]`` configuration section is now ordered. If you specify more - than one list of patterns, the first one that matches will be used. Fixes - `issue 649`_. - -- The :func:`.coverage.numbits.register_sqlite_functions` function now also - registers `numbits_to_nums` for use in SQLite queries. Thanks, Simon - Willison. - -- Python 3.9a1 is supported. - -- Coverage.py has a mascot: :ref:`Sleepy Snake `. - -.. _issue 649: https://github.com/nedbat/coveragepy/issues/649 -.. _issue 745: https://github.com/nedbat/coveragepy/issues/745 -.. _issue 838: https://github.com/nedbat/coveragepy/issues/838 -.. _issue 871: https://github.com/nedbat/coveragepy/issues/871 - - -.. _changes_50b1: - -Version 5.0b1 --- 2019-11-11 ----------------------------- - -- The HTML and textual reports now have a ``--skip-empty`` option that skips - files with no statements, notably ``__init__.py`` files. Thanks, Reya B. - -- Configuration can now be read from `TOML`_ files. This requires installing - coverage.py with the ``[toml]`` extra. The standard "pyproject.toml" file - will be read automatically if no other configuration file is found, with - settings in the ``[tool.coverage.]`` namespace. Thanks to Frazer McLean for - implementation and persistence. Finishes `issue 664`_. - -- The ``[run] note`` setting has been deprecated. Using it will result in a - warning, and the note will not be written to the data file. The - corresponding :class:`.CoverageData` methods have been removed. - -- The HTML report has been reimplemented (no more table around the source - code). This allowed for a better presentation of the context information, - hopefully resolving `issue 855`_. - -- Added sqlite3 module version information to ``coverage debug sys`` output. - -- Asking the HTML report to show contexts (``[html] show_contexts=True`` or - ``coverage html --show-contexts``) will issue a warning if there were no - contexts measured (`issue 851`_). - -.. _TOML: https://toml.io/ -.. _issue 664: https://github.com/nedbat/coveragepy/issues/664 -.. _issue 851: https://github.com/nedbat/coveragepy/issues/851 -.. _issue 855: https://github.com/nedbat/coveragepy/issues/855 - - -.. _changes_50a8: - -Version 5.0a8 --- 2019-10-02 ----------------------------- - -- The :class:`.CoverageData` API has changed how queries are limited to - specific contexts. Now you use :meth:`.CoverageData.set_query_context` to - set a single exact-match string, or :meth:`.CoverageData.set_query_contexts` - to set a list of regular expressions to match contexts. This changes the - command-line ``--contexts`` option to use regular expressions instead of - filename-style wildcards. - - -.. _changes_50a7: - -Version 5.0a7 --- 2019-09-21 ----------------------------- - -- Data can now be "reported" in JSON format, for programmatic use, as requested - in `issue 720`_. The new ``coverage json`` command writes raw and summarized - data to a JSON file. Thanks, Matt Bachmann. - -- Dynamic contexts are now supported in the Python tracer, which is important - for PyPy users. Closes `issue 846`_. - -- The compact line number representation introduced in 5.0a6 is called a - "numbits." The :mod:`coverage.numbits` module provides functions for working - with them. - -- The reporting methods used to permanently apply their arguments to the - configuration of the Coverage object. Now they no longer do. The arguments - affect the operation of the method, but do not persist. - -- A class named "test_something" no longer confuses the ``test_function`` - dynamic context setting. Fixes `issue 829`_. - -- Fixed an unusual tokenizing issue with backslashes in comments. Fixes - `issue 822`_. - -- ``debug=plugin`` didn't properly support configuration or dynamic context - plugins, but now it does, closing `issue 834`_. - -.. _issue 720: https://github.com/nedbat/coveragepy/issues/720 -.. _issue 822: https://github.com/nedbat/coveragepy/issues/822 -.. _issue 834: https://github.com/nedbat/coveragepy/issues/834 -.. _issue 829: https://github.com/nedbat/coveragepy/issues/829 -.. _issue 846: https://github.com/nedbat/coveragepy/issues/846 - - -.. _changes_50a6: - -Version 5.0a6 --- 2019-07-16 ----------------------------- - -- Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas - for the contribution. - - - The ``--contexts`` option is available on the ``report`` and ``html`` - commands. It's a comma-separated list of shell-style wildcards, selecting - the contexts to report on. Only contexts matching one of the wildcards - will be included in the report. - - - The ``--show-contexts`` option for the ``html`` command adds context - information to each covered line. Hovering over the "ctx" marker at the - end of the line reveals a list of the contexts that covered the line. - -- Database changes: - - - Line numbers are now stored in a much more compact way. For each file and - context, a single binary string is stored with a bit per line number. This - greatly improves memory use, but makes ad-hoc use difficult. - - - Dynamic contexts with no data are no longer written to the database. - - - SQLite data storage is now faster. There's no longer a reason to keep the - JSON data file code, so it has been removed. - -- Changes to the :class:`.CoverageData` interface: - - - The new :meth:`.CoverageData.dumps` method serializes the data to a string, - and a corresponding :meth:`.CoverageData.loads` method reconstitutes this - data. The format of the data string is subject to change at any time, and - so should only be used between two installations of the same version of - coverage.py. - - - The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new - argument, `no_disk` (default: False). Setting it to True prevents writing - any data to the disk. This is useful for transient data objects. - -- Added the classmethod :meth:`.Coverage.current` to get the latest started - Coverage instance. - -- Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes - `issue 828`_. - -- Error handling during reporting has changed slightly. All reporting methods - now behave the same. The ``--ignore-errors`` option keeps errors from - stopping the reporting, but files that couldn't parse as Python will always - be reported as warnings. As with other warnings, you can suppress them with - the ``[run] disable_warnings`` configuration setting. - -- Coverage.py no longer fails if the user program deletes its current - directory. Fixes `issue 806`_. Thanks, Dan Hemberger. - -- The scrollbar markers in the HTML report now accurately show the highlighted - lines, regardless of what categories of line are highlighted. - -- The hack to accommodate ShiningPanda_ looking for an obsolete internal data - file has been removed, since ShiningPanda 0.22 fixed it four years ago. - -- The deprecated `Reporter.file_reporters` property has been removed. - -.. _ShiningPanda: https://plugins.jenkins.io/shiningpanda/ -.. _issue 806: https://github.com/nedbat/coveragepy/pull/806 -.. _issue 828: https://github.com/nedbat/coveragepy/issues/828 - - -.. _changes_50a5: - -Version 5.0a5 --- 2019-05-07 ----------------------------- - -- Drop support for Python 3.4 - -- Dynamic contexts can now be set two new ways, both thanks to Justas - Sadzevičius. - - - A plugin can implement a ``dynamic_context`` method to check frames for - whether a new context should be started. See - :ref:`dynamic_context_plugins` for more details. - - - Another tool (such as a test runner) can use the new - :meth:`.Coverage.switch_context` method to explicitly change the context. - -- The ``dynamic_context = test_function`` setting now works with Python 2 - old-style classes, though it only reports the method name, not the class it - was defined on. Closes `issue 797`_. - -- ``fail_under`` values more than 100 are reported as errors. Thanks to Mike - Fiedler for closing `issue 746`_. - -- The "missing" values in the text output are now sorted by line number, so - that missing branches are reported near the other lines they affect. The - values used to show all missing lines, and then all missing branches. - -- Access to the SQLite database used for data storage is now thread-safe. - Thanks, Stephan Richter. This closes `issue 702`_. - -- Combining data stored in SQLite is now about twice as fast, fixing `issue - 761`_. Thanks, Stephan Richter. - -- The ``filename`` attribute on :class:`.CoverageData` objects has been made - private. You can use the ``data_filename`` method to get the actual file - name being used to store data, and the ``base_filename`` method to get the - original filename before parallelizing suffixes were added. This is part of - fixing `issue 708`_. - -- Line numbers in the HTML report now align properly with source lines, even - when Chrome's minimum font size is set, fixing `issue 748`_. Thanks Wen Ye. - -.. _issue 702: https://github.com/nedbat/coveragepy/issues/702 -.. _issue 708: https://github.com/nedbat/coveragepy/issues/708 -.. _issue 746: https://github.com/nedbat/coveragepy/issues/746 -.. _issue 748: https://github.com/nedbat/coveragepy/issues/748 -.. _issue 761: https://github.com/nedbat/coveragepy/issues/761 -.. _issue 797: https://github.com/nedbat/coveragepy/issues/797 - - -.. _changes_50a4: - -Version 5.0a4 --- 2018-11-25 ----------------------------- - -- You can specify the command line to run your program with the ``[run] - command_line`` configuration setting, as requested in `issue 695`_. - -- Coverage will create directories as needed for the data file if they don't - exist, closing `issue 721`_. - -- The ``coverage run`` command has always adjusted the first entry in sys.path, - to properly emulate how Python runs your program. Now this adjustment is - skipped if sys.path[0] is already different than Python's default. This - fixes `issue 715`_. - -- Improvements to context support: - - - The "no such table: meta" error is fixed.: `issue 716`_. - - - Combining data files is now much faster. - -- Python 3.8 (as of today!) passes all tests. - -.. _issue 695: https://github.com/nedbat/coveragepy/issues/695 -.. _issue 715: https://github.com/nedbat/coveragepy/issues/715 -.. _issue 716: https://github.com/nedbat/coveragepy/issues/716 -.. _issue 721: https://github.com/nedbat/coveragepy/issues/721 - - -.. _changes_50a3: - -Version 5.0a3 --- 2018-10-06 ----------------------------- - -- Context support: static contexts let you specify a label for a coverage run, - which is recorded in the data, and retained when you combine files. See - :ref:`contexts` for more information. - -- Dynamic contexts: specifying ``[run] dynamic_context = test_function`` in the - config file will record the test function name as a dynamic context during - execution. This is the core of "Who Tests What" (`issue 170`_). Things to - note: - - - There is no reporting support yet. Use SQLite to query the .coverage file - for information. Ideas are welcome about how reporting could be extended - to use this data. - - - There's a noticeable slow-down before any test is run. - - - Data files will now be roughly N times larger, where N is the number of - tests you have. Combining data files is therefore also N times slower. - - - No other values for ``dynamic_context`` are recognized yet. Let me know - what else would be useful. I'd like to use a pytest plugin to get better - information directly from pytest, for example. - -.. _issue 170: https://github.com/nedbat/coveragepy/issues/170 - -- Environment variable substitution in configuration files now supports two - syntaxes for controlling the behavior of undefined variables: if ``VARNAME`` - is not defined, ``${VARNAME?}`` will raise an error, and ``${VARNAME-default - value}`` will use "default value". - -- Partial support for Python 3.8, which has not yet released an alpha. Fixes - `issue 707`_ and `issue 714`_. - -.. _issue 707: https://github.com/nedbat/coveragepy/issues/707 -.. _issue 714: https://github.com/nedbat/coveragepy/issues/714 - - -.. _changes_50a2: - -Version 5.0a2 --- 2018-09-03 ----------------------------- - -- Coverage's data storage has changed. In version 4.x, .coverage files were - basically JSON. Now, they are SQLite databases. This means the data file - can be created earlier than it used to. A large amount of code was - refactored to support this change. - - - Because the data file is created differently than previous releases, you - may need ``parallel=true`` where you didn't before. - - - The old data format is still available (for now) by setting the environment - variable COVERAGE_STORAGE=json. Please tell me if you think you need to - keep the JSON format. - - - The database schema is guaranteed to change in the future, to support new - features. I'm looking for opinions about making the schema part of the - public API to coverage.py or not. - -- Development moved from `Bitbucket`_ to `GitHub`_. - -- HTML files no longer have trailing and extra whitespace. - -- The sort order in the HTML report is stored in local storage rather than - cookies, closing `issue 611`_. Thanks, Federico Bond. - -- pickle2json, for converting v3 data files to v4 data files, has been removed. - -.. _Bitbucket: https://bitbucket.org -.. _GitHub: https://github.com/nedbat/coveragepy - -.. _issue 611: https://github.com/nedbat/coveragepy/issues/611 - - -.. _changes_50a1: - -Version 5.0a1 --- 2018-06-05 ----------------------------- - -- Coverage.py no longer supports Python 2.6 or 3.3. - -- The location of the configuration file can now be specified with a - ``COVERAGE_RCFILE`` environment variable, as requested in `issue 650`_. - -- Namespace packages are supported on Python 3.7, where they used to cause - TypeErrors about path being None. Fixes `issue 700`_. - -- A new warning (``already-imported``) is issued if measurable files have - already been imported before coverage.py started measurement. See - :ref:`cmd_warnings` for more information. - -- Running coverage many times for small runs in a single process should be - faster, closing `issue 625`_. Thanks, David MacIver. - -- Large HTML report pages load faster. Thanks, Pankaj Pandey. - -.. _issue 625: https://github.com/nedbat/coveragepy/issues/625 -.. _issue 650: https://github.com/nedbat/coveragepy/issues/650 -.. _issue 700: https://github.com/nedbat/coveragepy/issues/700 - - -.. _changes_454: - -Version 4.5.4 --- 2019-07-29 ----------------------------- - -- Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes - `issue 828`_. - -.. _issue 828: https://github.com/nedbat/coveragepy/issues/828 - - -.. _changes_453: - -Version 4.5.3 --- 2019-03-09 ----------------------------- - -- Only packaging metadata changes. - - -.. _changes_452: - -Version 4.5.2 --- 2018-11-12 ----------------------------- - -- Namespace packages are supported on Python 3.7, where they used to cause - TypeErrors about path being None. Fixes `issue 700`_. - -- Python 3.8 (as of today!) passes all tests. Fixes `issue 707`_ and - `issue 714`_. - -- Development moved from `Bitbucket`_ to `GitHub`_. - -.. _issue 700: https://github.com/nedbat/coveragepy/issues/700 -.. _issue 707: https://github.com/nedbat/coveragepy/issues/707 -.. _issue 714: https://github.com/nedbat/coveragepy/issues/714 - -.. _Bitbucket: https://bitbucket.org -.. _GitHub: https://github.com/nedbat/coveragepy - - -.. _changes_451: - -Version 4.5.1 --- 2018-02-10 ----------------------------- - -- Now that 4.5 properly separated the ``[run] omit`` and ``[report] omit`` - settings, an old bug has become apparent. If you specified a package name - for ``[run] source``, then omit patterns weren't matched inside that package. - This bug (`issue 638`_) is now fixed. - -- On Python 3.7, reporting about a decorated function with no body other than a - docstring would crash coverage.py with an IndexError (`issue 640`_). This is - now fixed. - -- Configurer plugins are now reported in the output of ``--debug=sys``. - -.. _issue 638: https://github.com/nedbat/coveragepy/issues/638 -.. _issue 640: https://github.com/nedbat/coveragepy/issues/640 - - -.. _changes_45: - -Version 4.5 --- 2018-02-03 --------------------------- - -- A new kind of plugin is supported: configurers are invoked at start-up to - allow more complex configuration than the .coveragerc file can easily do. - See :ref:`api_plugin` for details. This solves the complex configuration - problem described in `issue 563`_. - -- The ``fail_under`` option can now be a float. Note that you must specify the - ``[report] precision`` configuration option for the fractional part to be - used. Thanks to Lars Hupfeldt Nielsen for help with the implementation. - Fixes `issue 631`_. - -- The ``include`` and ``omit`` options can be specified for both the ``[run]`` - and ``[report]`` phases of execution. 4.4.2 introduced some incorrect - interactions between those phases, where the options for one were confused - for the other. This is now corrected, fixing `issue 621`_ and `issue 622`_. - Thanks to Daniel Hahler for seeing more clearly than I could. - -- The ``coverage combine`` command used to always overwrite the data file, even - when no data had been read from apparently combinable files. Now, an error - is raised if we thought there were files to combine, but in fact none of them - could be used. Fixes `issue 629`_. - -- The ``coverage combine`` command could get confused about path separators - when combining data collected on Windows with data collected on Linux, as - described in `issue 618`_. This is now fixed: the result path always uses - the path separator specified in the ``[paths]`` result. - -- On Windows, the HTML report could fail when source trees are deeply nested, - due to attempting to create HTML filenames longer than the 250-character - maximum. Now filenames will never get much larger than 200 characters, - fixing `issue 627`_. Thanks to Alex Sandro for helping with the fix. - -.. _issue 563: https://github.com/nedbat/coveragepy/issues/563 -.. _issue 618: https://github.com/nedbat/coveragepy/issues/618 -.. _issue 621: https://github.com/nedbat/coveragepy/issues/621 -.. _issue 622: https://github.com/nedbat/coveragepy/issues/622 -.. _issue 627: https://github.com/nedbat/coveragepy/issues/627 -.. _issue 629: https://github.com/nedbat/coveragepy/issues/629 -.. _issue 631: https://github.com/nedbat/coveragepy/issues/631 - - -.. _changes_442: - -Version 4.4.2 --- 2017-11-05 ----------------------------- - -- Support for Python 3.7. In some cases, class and module docstrings are no - longer counted in statement totals, which could slightly change your total - results. - -- Specifying both ``--source`` and ``--include`` no longer silently ignores the - include setting, instead it displays a warning. Thanks, Loïc Dachary. Closes - `issue 265`_ and `issue 101`_. - -- Fixed a race condition when saving data and multiple threads are tracing - (`issue 581`_). It could produce a "dictionary changed size during iteration" - RuntimeError. I believe this mostly but not entirely fixes the race - condition. A true fix would likely be too expensive. Thanks, Peter Baughman - for the debugging, and Olivier Grisel for the fix with tests. - -- Configuration values which are file paths will now apply tilde-expansion, - closing `issue 589`_. - -- Now secondary config files like tox.ini and setup.cfg can be specified - explicitly, and prefixed sections like `[coverage:run]` will be read. Fixes - `issue 588`_. - -- Be more flexible about the command name displayed by help, fixing - `issue 600`_. Thanks, Ben Finney. - -.. _issue 101: https://github.com/nedbat/coveragepy/issues/101 -.. _issue 581: https://github.com/nedbat/coveragepy/issues/581 -.. _issue 588: https://github.com/nedbat/coveragepy/issues/588 -.. _issue 589: https://github.com/nedbat/coveragepy/issues/589 -.. _issue 600: https://github.com/nedbat/coveragepy/issues/600 - - -.. _changes_441: - -Version 4.4.1 --- 2017-05-14 ----------------------------- - -- No code changes: just corrected packaging for Python 2.7 Linux wheels. - - -.. _changes_44: - -Version 4.4 --- 2017-05-07 --------------------------- - -- 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 ```` and ```` 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://github.com/nedbat/coveragepy/issues/526 -.. _issue 572: https://github.com/nedbat/coveragepy/issues/572 -.. _issue 573: https://github.com/nedbat/coveragepy/issues/573 -.. _issue 575: https://github.com/nedbat/coveragepy/issues/575 - - -Version 4.4b1 --- 2017-04-04 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/79 -.. _issue 96: https://github.com/nedbat/coveragepy/issues/96 -.. _issue 355: https://github.com/nedbat/coveragepy/issues/355 -.. _issue 448: https://github.com/nedbat/coveragepy/issues/448 -.. _issue 570: https://github.com/nedbat/coveragepy/issues/570 - - -.. _changes_434: - -Version 4.3.4 --- 2017-01-17 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/556 - - -.. _changes_433: - -Version 4.3.3 --- 2017-01-17 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/554 - - -.. _changes_432: - -Version 4.3.2 --- 2017-01-16 ----------------------------- - -- 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 achieved 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://github.com/nedbat/coveragepy/issues/322 -.. _issue 426: https://github.com/nedbat/coveragepy/issues/426 -.. _issue 522: https://github.com/nedbat/coveragepy/issues/522 -.. _issue 549: https://github.com/nedbat/coveragepy/issues/549 -.. _issue 551: https://github.com/nedbat/coveragepy/issues/551 - - -.. _changes_431: - -Version 4.3.1 --- 2016-12-28 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/540 -.. _issue 541: https://github.com/nedbat/coveragepy/issues/541 - - -.. _changes_43: - -Version 4.3 --- 2016-12-27 --------------------------- - -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.html#sys.excepthook -.. _issue 265: https://github.com/nedbat/coveragepy/issues/265 -.. _issue 412: https://github.com/nedbat/coveragepy/issues/412 -.. _issue 433: https://github.com/nedbat/coveragepy/issues/433 -.. _issue 493: https://github.com/nedbat/coveragepy/issues/493 -.. _issue 496: https://github.com/nedbat/coveragepy/issues/496 -.. _issue 502: https://github.com/nedbat/coveragepy/issues/502 -.. _issue 505: https://github.com/nedbat/coveragepy/issues/505 -.. _issue 514: https://github.com/nedbat/coveragepy/issues/514 -.. _issue 510: https://github.com/nedbat/coveragepy/issues/510 -.. _issue 511: https://github.com/nedbat/coveragepy/issues/511 -.. _issue 516: https://github.com/nedbat/coveragepy/issues/516 -.. _issue 519: https://github.com/nedbat/coveragepy/issues/519 -.. _issue 524: https://github.com/nedbat/coveragepy/issues/524 -.. _issue 525: https://github.com/nedbat/coveragepy/issues/525 -.. _issue 529: https://github.com/nedbat/coveragepy/issues/529 -.. _issue 530: https://github.com/nedbat/coveragepy/issues/530 -.. _issue 533: https://github.com/nedbat/coveragepy/issues/533 -.. _issue 535: https://github.com/nedbat/coveragepy/issues/535 - - -.. _changes_42: - -Version 4.2 --- 2016-07-26 --------------------------- - -- 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://github.com/nedbat/coveragepy/issues/495 - - -Version 4.2b1 --- 2016-07-04 ----------------------------- - -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: https://coverage.readthedocs.io/en/latest/subprocess.html -.. _issue 199: https://github.com/nedbat/coveragepy/issues/199 -.. _issue 231: https://github.com/nedbat/coveragepy/issues/231 -.. _issue 298: https://github.com/nedbat/coveragepy/issues/298 -.. _issue 396: https://github.com/nedbat/coveragepy/issues/396 -.. _issue 454: https://github.com/nedbat/coveragepy/issues/454 -.. _issue 478: https://github.com/nedbat/coveragepy/issues/478 -.. _issue 484: https://github.com/nedbat/coveragepy/issues/484 -.. _issue 492: https://github.com/nedbat/coveragepy/issues/492 -.. _unittest-mixins: https://pypi.org/project/unittest-mixins/ - - -.. _changes_41: - -Version 4.1 --- 2016-05-21 --------------------------- - -- 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. - - -Version 4.1b3 --- 2016-05-10 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/90 -.. _issue 245: https://github.com/nedbat/coveragepy/issues/245 -.. _issue 440: https://github.com/nedbat/coveragepy/issues/440 -.. _issue 456: https://github.com/nedbat/coveragepy/issues/456 -.. _issue 460: https://github.com/nedbat/coveragepy/issues/460 -.. _issue 469: https://github.com/nedbat/coveragepy/issues/469 -.. _issue 472: https://github.com/nedbat/coveragepy/issues/472 -.. _issue 475: https://github.com/nedbat/coveragepy/issues/475 -.. _issue 479: https://github.com/nedbat/coveragepy/issues/479 -.. _issue 481: https://github.com/nedbat/coveragepy/issues/481 -.. _issue 485: https://github.com/nedbat/coveragepy/issues/485 - - -Version 4.1b2 --- 2016-01-23 ----------------------------- - -- Problems with the new branch measurement in 4.1 beta 1 were fixed: - - - Class docstrings were considered executable. Now they no longer are. - - - ``yield from`` and ``await`` were considered returns from functions, since - they could transfer control to the caller. This produced unhelpful - "missing branch" reports in a number of circumstances. Now they no longer - are considered returns. - - - In unusual situations, a missing branch to a negative number was reported. - This has been fixed, closing `issue 466`_. - -- The XML report now produces correct package names for modules found in - directories specified with ``source=``. Fixes `issue 465`_. - -- ``coverage report`` won't produce trailing whitespace. - -.. _issue 465: https://github.com/nedbat/coveragepy/issues/465 -.. _issue 466: https://github.com/nedbat/coveragepy/issues/466 - - -Version 4.1b1 --- 2016-01-10 ----------------------------- - -- Branch analysis has been rewritten: it used to be based on bytecode, but now - uses AST analysis. This has changed a number of things: - - - More code paths are now considered runnable, especially in - ``try``/``except`` structures. This may mean that coverage.py will - identify more code paths as uncovered. This could either raise or lower - your overall coverage number. - - - Python 3.5's ``async`` and ``await`` keywords are properly supported, - fixing `issue 434`_. - - - Some long-standing branch coverage bugs were fixed: - - - `issue 129`_: functions with only a docstring for a body would - incorrectly report a missing branch on the ``def`` line. - - - `issue 212`_: code in an ``except`` block could be incorrectly marked as - a missing branch. - - - `issue 146`_: context managers (``with`` statements) in a loop or ``try`` - block could confuse the branch measurement, reporting incorrect partial - branches. - - - `issue 422`_: in Python 3.5, an actual partial branch could be marked as - complete. - -- Pragmas to disable coverage measurement can now be used on decorator lines, - and they will apply to the entire function or class being decorated. This - implements the feature requested in `issue 131`_. - -- Multiprocessing support is now available on Windows. Thanks, Rodrigue - Cloutier. - -- Files with two encoding declarations are properly supported, fixing - `issue 453`_. Thanks, Max Linke. - -- Non-ascii characters in regexes in the configuration file worked in 3.7, but - stopped working in 4.0. Now they work again, closing `issue 455`_. - -- Form-feed characters would prevent accurate determination of the beginning of - statements in the rest of the file. This is now fixed, closing `issue 461`_. - -.. _issue 129: https://github.com/nedbat/coveragepy/issues/129 -.. _issue 131: https://github.com/nedbat/coveragepy/issues/131 -.. _issue 146: https://github.com/nedbat/coveragepy/issues/146 -.. _issue 212: https://github.com/nedbat/coveragepy/issues/212 -.. _issue 422: https://github.com/nedbat/coveragepy/issues/422 -.. _issue 434: https://github.com/nedbat/coveragepy/issues/434 -.. _issue 453: https://github.com/nedbat/coveragepy/issues/453 -.. _issue 455: https://github.com/nedbat/coveragepy/issues/455 -.. _issue 461: https://github.com/nedbat/coveragepy/issues/461 - - -.. _changes_403: - -Version 4.0.3 --- 2015-11-24 ----------------------------- - -- Fixed a mysterious problem that manifested in different ways: sometimes - hanging the process (`issue 420`_), sometimes making database connections - fail (`issue 445`_). - -- The XML report now has correct ```` elements when using a - ``--source=`` option somewhere besides the current directory. This fixes - `issue 439`_. Thanks, Arcadiy Ivanov. - -- Fixed an unusual edge case of detecting source encodings, described in - `issue 443`_. - -- Help messages that mention the command to use now properly use the actual - command name, which might be different than "coverage". Thanks to Ben - Finney, this closes `issue 438`_. - -.. _issue 420: https://github.com/nedbat/coveragepy/issues/420 -.. _issue 438: https://github.com/nedbat/coveragepy/issues/438 -.. _issue 439: https://github.com/nedbat/coveragepy/issues/439 -.. _issue 443: https://github.com/nedbat/coveragepy/issues/443 -.. _issue 445: https://github.com/nedbat/coveragepy/issues/445 - - -.. _changes_402: - -Version 4.0.2 --- 2015-11-04 ----------------------------- - -- More work on supporting unusually encoded source. Fixed `issue 431`_. - -- Files or directories with non-ASCII characters are now handled properly, - fixing `issue 432`_. - -- Setting a trace function with sys.settrace was broken by a change in 4.0.1, - as reported in `issue 436`_. This is now fixed. - -- Officially support PyPy 4.0, which required no changes, just updates to the - docs. - -.. _issue 431: https://github.com/nedbat/coveragepy/issues/431 -.. _issue 432: https://github.com/nedbat/coveragepy/issues/432 -.. _issue 436: https://github.com/nedbat/coveragepy/issues/436 - - -.. _changes_401: - -Version 4.0.1 --- 2015-10-13 ----------------------------- - -- When combining data files, unreadable files will now generate a warning - instead of failing the command. This is more in line with the older - coverage.py v3.7.1 behavior, which silently ignored unreadable files. - Prompted by `issue 418`_. - -- The --skip-covered option would skip reporting on 100% covered files, but - also skipped them when calculating total coverage. This was wrong, it should - only remove lines from the report, not change the final answer. This is now - fixed, closing `issue 423`_. - -- In 4.0, the data file recorded a summary of the system on which it was run. - Combined data files would keep all of those summaries. This could lead to - enormous data files consisting of mostly repetitive useless information. That - summary is now gone, fixing `issue 415`_. If you want summary information, - get in touch, and we'll figure out a better way to do it. - -- Test suites that mocked os.path.exists would experience strange failures, due - to coverage.py using their mock inadvertently. This is now fixed, closing - `issue 416`_. - -- Importing a ``__init__`` module explicitly would lead to an error: - ``AttributeError: 'module' object has no attribute '__path__'``, as reported - in `issue 410`_. This is now fixed. - -- Code that uses ``sys.settrace(sys.gettrace())`` used to incur a more than 2x - speed penalty. Now there's no penalty at all. Fixes `issue 397`_. - -- Pyexpat C code will no longer be recorded as a source file, fixing - `issue 419`_. - -- The source kit now contains all of the files needed to have a complete source - tree, re-fixing `issue 137`_ and closing `issue 281`_. - -.. _issue 281: https://github.com/nedbat/coveragepy/issues/281 -.. _issue 397: https://github.com/nedbat/coveragepy/issues/397 -.. _issue 410: https://github.com/nedbat/coveragepy/issues/410 -.. _issue 415: https://github.com/nedbat/coveragepy/issues/415 -.. _issue 416: https://github.com/nedbat/coveragepy/issues/416 -.. _issue 418: https://github.com/nedbat/coveragepy/issues/418 -.. _issue 419: https://github.com/nedbat/coveragepy/issues/419 -.. _issue 423: https://github.com/nedbat/coveragepy/issues/423 - - -.. _changes_40: - -Version 4.0 --- 2015-09-20 --------------------------- - -No changes from 4.0b3 - - -Version 4.0b3 --- 2015-09-07 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/403 -.. _issue 404: https://github.com/nedbat/coveragepy/issues/404 - - -Version 4.0b2 --- 2015-08-22 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/392 -.. _issue 395: https://github.com/nedbat/coveragepy/issues/395 -.. _issue 399: https://github.com/nedbat/coveragepy/issues/399 -.. _sys.version_info: https://docs.python.org/3/library/sys.html#sys.version_info - - -Version 4.0b1 --- 2015-08-02 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/236 -.. _issue 252: https://github.com/nedbat/coveragepy/issues/252 -.. _issue 262: https://github.com/nedbat/coveragepy/issues/262 -.. _issue 275: https://github.com/nedbat/coveragepy/issues/275 -.. _issue 313: https://github.com/nedbat/coveragepy/issues/313 -.. _issue 380: https://github.com/nedbat/coveragepy/issues/380 -.. _issue 385: https://github.com/nedbat/coveragepy/issues/385 -.. _issue 386: https://github.com/nedbat/coveragepy/issues/386 -.. _issue 387: https://github.com/nedbat/coveragepy/issues/387 - -.. 40 issues closed in 4.0 below here - - -Version 4.0a6 --- 2015-06-21 ----------------------------- - -- Python 3.5b2 and PyPy 2.6.0 are supported. - -- 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 `_. - -- 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://github.com/nedbat/coveragepy/issues/299 -.. _issue 308: https://github.com/nedbat/coveragepy/issues/308 -.. _issue 324: https://github.com/nedbat/coveragepy/issues/324 -.. _issue 351: https://github.com/nedbat/coveragepy/issues/351 -.. _issue 354: https://github.com/nedbat/coveragepy/issues/354 -.. _issue 359: https://github.com/nedbat/coveragepy/issues/359 -.. _issue 360: https://github.com/nedbat/coveragepy/issues/360 -.. _issue 361: https://github.com/nedbat/coveragepy/issues/361 -.. _issue 363: https://github.com/nedbat/coveragepy/issues/363 -.. _issue 374: https://github.com/nedbat/coveragepy/issues/374 -.. _issue 375: https://github.com/nedbat/coveragepy/issues/375 - - -Version 4.0a5 --- 2015-02-16 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/117 -.. _issue 340: https://github.com/nedbat/coveragepy/issues/340 -.. _issue 353: https://github.com/nedbat/coveragepy/issues/353 -.. _issue 357: https://github.com/nedbat/coveragepy/issues/357 -.. _issue 358: https://github.com/nedbat/coveragepy/issues/358 - - -Version 4.0a4 --- 2015-01-25 ----------------------------- - -- Plugins can now provide sys_info for debugging output. - -- Started plugins documentation. - -- Prepared to move the docs to readthedocs.org. - - -Version 4.0a3 --- 2015-01-20 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/69 -.. _issue 235: https://github.com/nedbat/coveragepy/issues/235 -.. _issue 290: https://github.com/nedbat/coveragepy/issues/290 -.. _issue 345: https://github.com/nedbat/coveragepy/issues/345 -.. _issue 349: https://github.com/nedbat/coveragepy/issues/349 - - -Version 4.0a2 --- 2015-01-14 ----------------------------- - -- 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://github.com/nedbat/coveragepy/issues/237 -.. _issue 287: https://github.com/nedbat/coveragepy/issues/287 -.. _issue 293: https://github.com/nedbat/coveragepy/issues/293 -.. _issue 314: https://github.com/nedbat/coveragepy/issues/314 -.. _issue 315: https://github.com/nedbat/coveragepy/issues/315 -.. _issue 328: https://github.com/nedbat/coveragepy/issues/328 -.. _issue 334: https://github.com/nedbat/coveragepy/issues/334 -.. _issue 342: https://github.com/nedbat/coveragepy/issues/342 -.. _issue 343: https://github.com/nedbat/coveragepy/issues/343 - - -Version 4.0a1 --- 2014-09-27 ----------------------------- - -- 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 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://github.com/nedbat/coveragepy/issues/57 -.. _issue 94: https://github.com/nedbat/coveragepy/issues/94 -.. _issue 149: https://github.com/nedbat/coveragepy/issues/149 -.. _issue 230: https://github.com/nedbat/coveragepy/issues/230 -.. _issue 284: https://github.com/nedbat/coveragepy/issues/284 -.. _issue 285: https://github.com/nedbat/coveragepy/issues/285 -.. _issue 303: https://github.com/nedbat/coveragepy/issues/303 -.. _issue 304: https://github.com/nedbat/coveragepy/issues/304 -.. _issue 305: https://github.com/nedbat/coveragepy/issues/305 -.. _issue 331: https://github.com/nedbat/coveragepy/issues/331 - - -.. _changes_371: - -Version 3.7.1 --- 2013-12-13 ----------------------------- - -- 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. - - -.. _changes_37: - -Version 3.7 --- 2013-10-06 --------------------------- - -- 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.py can now run .pyc files directly, closing `issue 264`_. - -- 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. - -- When specifying paths to alias together during data combining, you can now - specify relative paths, fixing `issue 267`_. - -- Most file paths can now be specified with username expansion (``~/src``, or - ``~build/src``, for example), and with environment variable expansion - (``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.py no - longer issues a spurious warning about the trace function changing: "Trace - 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 - decoded properly. Now they are. Thanks, Roger Hu. - -- The source kit now includes the ``__main__.py`` file in the root coverage - directory, fixing `issue 255`_. - -.. _issue 92: https://github.com/nedbat/coveragepy/issues/92 -.. _issue 164: https://github.com/nedbat/coveragepy/issues/164 -.. _issue 175: https://github.com/nedbat/coveragepy/issues/175 -.. _issue 207: https://github.com/nedbat/coveragepy/issues/207 -.. _issue 242: https://github.com/nedbat/coveragepy/issues/242 -.. _issue 218: https://github.com/nedbat/coveragepy/issues/218 -.. _issue 250: https://github.com/nedbat/coveragepy/issues/250 -.. _issue 255: https://github.com/nedbat/coveragepy/issues/255 -.. _issue 259: https://github.com/nedbat/coveragepy/issues/259 -.. _issue 261: https://github.com/nedbat/coveragepy/issues/261 -.. _issue 264: https://github.com/nedbat/coveragepy/issues/264 -.. _issue 267: https://github.com/nedbat/coveragepy/issues/267 - - -.. _changes_36: - -Version 3.6 --- 2013-01-05 --------------------------- - -- Added a page to the docs about troublesome situations, closing `issue 226`_, - and added some info to the TODO file, closing `issue 227`_. - -.. _issue 226: https://github.com/nedbat/coveragepy/issues/226 -.. _issue 227: https://github.com/nedbat/coveragepy/issues/227 - - -Version 3.6b3 --- 2012-12-29 ----------------------------- - -- Beta 2 broke the nose plugin. It's fixed again, closing `issue 224`_. - -.. _issue 224: https://github.com/nedbat/coveragepy/issues/224 - - -Version 3.6b2 --- 2012-12-23 ----------------------------- - -- Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1. - -- The C extension is optionally compiled using a different more widely-used - technique, taking another stab at fixing `issue 80`_ once and for all. - -- Combining data files would create entries for phantom files if used with - ``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 - file name, coverage.py no longer associates it with the directory name, - fixing `issue 221`_. - -.. _issue 221: https://github.com/nedbat/coveragepy/issues/221 - - -Version 3.6b1 --- 2012-11-28 ----------------------------- - -- Wildcards in ``include=`` and ``omit=`` arguments were not handled properly - in reporting functions, though they were when running. Now they are handled - uniformly, closing `issue 143`_ and `issue 163`_. **NOTE**: it is possible - that your configurations may now be incorrect. If you use ``include`` or - ``omit`` during reporting, whether on the command line, through the API, or - in a configuration file, please check carefully that you were not relying on - the old broken behavior. - -- The **report**, **html**, and **xml** commands now accept a ``--fail-under`` - switch that indicates in the exit status whether the coverage percentage was - less than a particular value. Closes `issue 139`_. - -- The reporting functions coverage.report(), coverage.html_report(), and - coverage.xml_report() now all return a float, the total percentage covered - measurement. - -- The HTML report's title can now be set in the configuration file, with the - ``--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 - didn't work. Now it does. - -- 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 - correctly have 0% coverage, fixing `issue 156`_. This also means that your - total coverage numbers will generally now be lower if you are measuring - branch coverage. - -- When installing, now in addition to creating a "coverage" command, two new - aliases are also installed. A "coverage2" or "coverage3" command will be - created, depending on whether you are installing in Python 2.x or 3.x. - A "coverage-X.Y" command will also be created corresponding to your specific - version of Python. Closes `issue 111`_. - -- The coverage.py installer no longer tries to bootstrap setuptools or - Distribute. You must have one of them installed first, as `issue 202`_ - recommended. - -- The coverage.py kit now includes docs (closing `issue 137`_) and tests. - -- On Windows, files are now reported in their correct case, fixing `issue 89`_ - and `issue 203`_. - -- If a file is missing during reporting, the path shown in the error message - is now correct, rather than an incorrect path in the current directory. - Fixes `issue 60`_. - -- Running an HTML report in Python 3 in the same directory as an old Python 2 - HTML report would fail with a UnicodeDecodeError. This issue (`issue 193`_) - is now fixed. - -- Fixed yet another error trying to parse non-Python files as Python, this - time an IndentationError, closing `issue 82`_ for the fourth time... - -- 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.py under a debugger is unlikely to work, but it shouldn't - 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 documentation for the class `coverage.coverage`. - Closes `issue 206`_. - -- Added a page to the docs about contributing to coverage.py, closing - `issue 171`_. - -- When coverage.py ended unsuccessfully, it may have reported odd errors like - ``'NoneType' object has no attribute 'isabs'``. It no longer does, - so kiss `issue 153`_ goodbye. - -.. _issue 60: https://github.com/nedbat/coveragepy/issues/60 -.. _issue 67: https://github.com/nedbat/coveragepy/issues/67 -.. _issue 89: https://github.com/nedbat/coveragepy/issues/89 -.. _issue 97: https://github.com/nedbat/coveragepy/issues/97 -.. _issue 100: https://github.com/nedbat/coveragepy/issues/100 -.. _issue 111: https://github.com/nedbat/coveragepy/issues/111 -.. _issue 137: https://github.com/nedbat/coveragepy/issues/137 -.. _issue 139: https://github.com/nedbat/coveragepy/issues/139 -.. _issue 143: https://github.com/nedbat/coveragepy/issues/143 -.. _issue 153: https://github.com/nedbat/coveragepy/issues/153 -.. _issue 156: https://github.com/nedbat/coveragepy/issues/156 -.. _issue 163: https://github.com/nedbat/coveragepy/issues/163 -.. _issue 171: https://github.com/nedbat/coveragepy/issues/171 -.. _issue 193: https://github.com/nedbat/coveragepy/issues/193 -.. _issue 201: https://github.com/nedbat/coveragepy/issues/201 -.. _issue 202: https://github.com/nedbat/coveragepy/issues/202 -.. _issue 203: https://github.com/nedbat/coveragepy/issues/203 -.. _issue 205: https://github.com/nedbat/coveragepy/issues/205 -.. _issue 206: https://github.com/nedbat/coveragepy/issues/206 -.. _issue 210: https://github.com/nedbat/coveragepy/issues/210 -.. _issue 214: https://github.com/nedbat/coveragepy/issues/214 - - -.. _changes_353: - -Version 3.5.3 --- 2012-09-29 ----------------------------- - -- 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 sub-directories do, - 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 - then not being able to parse them as Python. Closes `issue 82`_ (again). - Thanks, Julian Berman. - -- Fixed memory leaks under Python 3, thanks, Brett Cannon. Closes `issue 147`_. - -- Optimized .pyo files may not have been handled correctly, `issue 195`_. - Thanks, Marius Gedminas. - -- Certain unusually named file paths could have been mangled during reporting, - `issue 194`_. Thanks, Marius Gedminas. - -- 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 147: https://github.com/nedbat/coveragepy/issues/147 -.. _issue 179: https://github.com/nedbat/coveragepy/issues/179 -.. _issue 183: https://github.com/nedbat/coveragepy/issues/183 -.. _issue 194: https://github.com/nedbat/coveragepy/issues/194 -.. _issue 195: https://github.com/nedbat/coveragepy/issues/195 -.. _issue 197: https://github.com/nedbat/coveragepy/issues/197 -.. _tox: https://tox.readthedocs.io/ - - -.. _changes_352: - -Version 3.5.2 --- 2012-05-04 ----------------------------- - -No changes since 3.5.2.b1 - - -Version 3.5.2b1 --- 2012-04-29 ------------------------------- - -- 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. - -- 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 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 specified as ``show_missing`` in the - config file. Closes `issue 173`_. - -- When running a module with ``coverage run -m ``, certain details - of the execution environment weren't the same as for - ``python -m ``. This had the unfortunate side-effect of making - ``coverage run -m unittest discover`` not work if you had tests in a - directory named "test". This fixes `issue 155`_ and `issue 142`_. - -- Now the exit status of your product code is properly used as the process - 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 142: https://github.com/nedbat/coveragepy/issues/142 -.. _issue 155: https://github.com/nedbat/coveragepy/issues/155 -.. _issue 157: https://github.com/nedbat/coveragepy/issues/157 -.. _issue 166: https://github.com/nedbat/coveragepy/issues/166 -.. _issue 168: https://github.com/nedbat/coveragepy/issues/168 -.. _issue 173: https://github.com/nedbat/coveragepy/issues/173 - - -.. _changes_351: - -Version 3.5.1 --- 2011-09-23 ----------------------------- - -- The ``[paths]`` feature unfortunately didn't work in real world situations - where you wanted to, you know, report on the combined data. Now all paths - stored in the combined file are canonicalized properly. - - -Version 3.5.1b1 --- 2011-08-28 ------------------------------- - -- When combining data files from parallel runs, you can now instruct - coverage.py about which directories are equivalent on different machines. A - ``[paths]`` section in the configuration file lists paths that are to be - 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`_. - -- The number of partial branches reported on the HTML summary page was - 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 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.py code before anything else in the process. - See the coverage/fullcoverage directory if you are interested. - -.. _issue 17: https://github.com/nedbat/coveragepy/issues/17 -.. _issue 122: https://github.com/nedbat/coveragepy/issues/122 -.. _issue 124: https://github.com/nedbat/coveragepy/issues/124 -.. _issue 128: https://github.com/nedbat/coveragepy/issues/128 -.. _issue 138: https://github.com/nedbat/coveragepy/issues/138 -.. _issue 144: https://github.com/nedbat/coveragepy/issues/144 - - -.. _changes_35: - -Version 3.5 --- 2011-06-29 --------------------------- - -- The HTML report hotkeys now behave slightly differently when the current - chunk isn't visible at all: a chunk on the screen will be selected, - instead of the old behavior of jumping to the literal next chunk. - The hotkeys now work in Google Chrome. Thanks, Guido van Rossum. - - -Version 3.5b1 --- 2011-06-05 ----------------------------- - -- The HTML report now has hotkeys. Try ``n``, ``s``, ``m``, ``x``, ``b``, - ``p``, and ``c`` on the overview page to change the column sorting. - On a file page, ``r``, ``m``, ``x``, and ``p`` toggle the run, missing, - excluded, and partial line markings. You can navigate the highlighted - sections of code by using the ``j`` and ``k`` keys for next and previous. - The ``1`` (one) key jumps to the first highlighted section in the file, - and ``0`` (zero) scrolls to the top of the file. - -- The ``--omit`` and ``--include`` switches now interpret their values more - usefully. If the value starts with a wildcard character, it is used as-is. - If it does not, it is interpreted relative to the current directory. - Closes `issue 121`_. - -- Partial branch warnings can now be pragma'd away. The configuration option - ``partial_branches`` is a list of regular expressions. Lines matching any of - those expressions will never be marked as a partial branch. In addition, - there's a built-in list of regular expressions marking statements which - should never be marked as partial. This list includes ``while True:``, - ``while 1:``, ``if 1:``, and ``if 0:``. - -- The ``coverage()`` constructor accepts single strings for the ``omit=`` and - ``include=`` arguments, adapting to a common error in programmatic use. - -- Modules can now be run directly using ``coverage run -m modulename``, to - mirror Python's ``-m`` flag. Closes `issue 95`_, thanks, Brandon Rhodes. - -- ``coverage run`` didn't emulate Python accurately in one small detail: the - current directory inserted into ``sys.path`` was relative rather than - absolute. This is now fixed. - -- HTML reporting is now incremental: a record is kept of the data that - produced the HTML reports, and only files whose data has changed will - be generated. This should make most HTML reporting faster. - -- Pathological code execution could disable the trace function behind our - backs, leading to incorrect code measurement. Now if this happens, - coverage.py will issue a warning, at least alerting you to the problem. - Closes `issue 93`_. Thanks to Marius Gedminas for the idea. - -- The C-based trace function now behaves properly when saved and restored - with ``sys.gettrace()`` and ``sys.settrace()``. This fixes `issue 125`_ - and `issue 123`_. Thanks, Devin Jeanpierre. - -- Source files are now opened with Python 3.2's ``tokenize.open()`` where - possible, to get the best handling of Python source files with encodings. - Closes `issue 107`_, thanks, Brett Cannon. - -- Syntax errors in supposed Python files can now be ignored during reporting - with the ``-i`` switch just like other source errors. Closes `issue 115`_. - -- Installation from source now succeeds on machines without a C compiler, - closing `issue 80`_. - -- Coverage.py can now be run directly from a working tree by specifying - the directory name to python: ``python coverage_py_working_dir run ...``. - Thanks, Brett Cannon. - -- A little bit of Jython support: `coverage run` can now measure Jython - execution by adapting when $py.class files are traced. Thanks, Adi Roiban. - Jython still doesn't provide the Python libraries needed to make - coverage reporting work, unfortunately. - -- Internally, files are now closed explicitly, fixing `issue 104`_. Thanks, - Brett Cannon. - -.. _issue 80: https://github.com/nedbat/coveragepy/issues/80 -.. _issue 93: https://github.com/nedbat/coveragepy/issues/93 -.. _issue 95: https://github.com/nedbat/coveragepy/issues/95 -.. _issue 104: https://github.com/nedbat/coveragepy/issues/104 -.. _issue 107: https://github.com/nedbat/coveragepy/issues/107 -.. _issue 115: https://github.com/nedbat/coveragepy/issues/115 -.. _issue 121: https://github.com/nedbat/coveragepy/issues/121 -.. _issue 123: https://github.com/nedbat/coveragepy/issues/123 -.. _issue 125: https://github.com/nedbat/coveragepy/issues/125 - - -.. _changes_34: - -Version 3.4 --- 2010-09-19 --------------------------- - -- The XML report is now sorted by package name, fixing `issue 88`_. - -- Programs that exited with ``sys.exit()`` with no argument weren't handled - properly, producing a coverage.py stack trace. That is now fixed. - -.. _issue 88: https://github.com/nedbat/coveragepy/issues/88 - - -Version 3.4b2 --- 2010-09-06 ----------------------------- - -- Completely unexecuted files can now be included in coverage results, reported - as 0% covered. This only happens if the --source option is specified, since - coverage.py needs guidance about where to look for source files. - -- The XML report output now properly includes a percentage for branch coverage, - fixing `issue 65`_ and `issue 81`_. - -- Coverage percentages are now displayed uniformly across reporting methods. - Previously, different reports could round percentages differently. Also, - percentages are only reported as 0% or 100% if they are truly 0 or 100, and - are rounded otherwise. Fixes `issue 41`_ and `issue 70`_. - -- The precision of reported coverage percentages can be set with the - ``[report] precision`` config file setting. Completes `issue 16`_. - -- Threads derived from ``threading.Thread`` with an overridden `run` method - would report no coverage for the `run` method. This is now fixed, closing - `issue 85`_. - -.. _issue 16: https://github.com/nedbat/coveragepy/issues/16 -.. _issue 41: https://github.com/nedbat/coveragepy/issues/41 -.. _issue 65: https://github.com/nedbat/coveragepy/issues/65 -.. _issue 70: https://github.com/nedbat/coveragepy/issues/70 -.. _issue 81: https://github.com/nedbat/coveragepy/issues/81 -.. _issue 85: https://github.com/nedbat/coveragepy/issues/85 - - -Version 3.4b1 --- 2010-08-21 ----------------------------- - -- 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 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. - -- Various warnings are printed to stderr for problems encountered during data - measurement: if a ``--source`` module has no Python source to measure, or is - never encountered at all, or if no data is collected. - -- The reporting commands (report, annotate, html, and xml) now have an - ``--include`` switch to restrict reporting to modules matching those file - patterns, similar to the existing ``--omit`` switch. Thanks, Zooko. - -- The run command now supports ``--include`` and ``--omit`` to control what - modules it measures. This can speed execution and reduce the amount of data - during reporting. Thanks Zooko. - -- Since coverage.py 3.1, using the Python trace function has been slower than - it needs to be. A cache of tracing decisions was broken, but has now been - fixed. - -- Python 2.7 and 3.2 have introduced new opcodes that are now supported. - -- Python files with no statements, for example, empty ``__init__.py`` files, - are now reported as having zero statements instead of one. Fixes `issue 1`_. - -- Reports now have a column of missed line counts rather than executed line - counts, since developers should focus on reducing the missed lines to zero, - rather than increasing the executed lines to varying targets. Once - suggested, this seemed blindingly obvious. - -- Line numbers in HTML source pages are clickable, linking directly to that - line, which is highlighted on arrival. Added a link back to the index page - at the bottom of each HTML page. - -- 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.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 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`_. - -- Source files with DOS line endings are now properly tokenized for syntax - coloring on non-DOS machines. Fixes `issue 53`_. - -- Unusual code structure that confused exits from methods with exits from - classes is now properly analyzed. See `issue 62`_. - -- Asking for an HTML report with no files now shows a nice error message rather - than a cryptic failure ('int' object is unsubscriptable). Fixes `issue 59`_. - -.. _issue 1: https://github.com/nedbat/coveragepy/issues/1 -.. _issue 34: https://github.com/nedbat/coveragepy/issues/34 -.. _issue 36: https://github.com/nedbat/coveragepy/issues/36 -.. _issue 46: https://github.com/nedbat/coveragepy/issues/46 -.. _issue 53: https://github.com/nedbat/coveragepy/issues/53 -.. _issue 52: https://github.com/nedbat/coveragepy/issues/52 -.. _issue 56: https://github.com/nedbat/coveragepy/issues/56 -.. _issue 61: https://github.com/nedbat/coveragepy/issues/61 -.. _issue 62: https://github.com/nedbat/coveragepy/issues/62 -.. _issue 59: https://github.com/nedbat/coveragepy/issues/59 -.. _issue 82: https://github.com/nedbat/coveragepy/issues/82 - - -.. _changes_331: - -Version 3.3.1 --- 2010-03-06 ----------------------------- - -- Using `parallel=True` in .coveragerc file prevented reporting, but now does - not, fixing `issue 49`_. - -- When running your code with "coverage run", if you call `sys.exit()`, - coverage.py will exit with that status code, fixing `issue 50`_. - -.. _issue 49: https://github.com/nedbat/coveragepy/issues/49 -.. _issue 50: https://github.com/nedbat/coveragepy/issues/50 - - -.. _changes_33: - -Version 3.3 --- 2010-02-24 --------------------------- - -- Settings are now read from a .coveragerc file. A specific file can be - specified on the command line with --rcfile=FILE. The name of the file can - be programmatically set with the `config_file` argument to the coverage() - constructor, or reading a config file can be disabled with - `config_file=False`. - -- Fixed a problem with nested loops having their branch possibilities - mischaracterized: `issue 39`_. - -- Added coverage.process_start to enable coverage measurement when Python - starts. - -- Parallel data file names now have a random number appended to them in - addition to the machine name and process id. - -- Parallel data files combined with "coverage combine" are deleted after - they're combined, to clean up unneeded files. Fixes `issue 40`_. - -- Exceptions thrown from product code run with "coverage run" are now displayed - without internal coverage.py frames, so the output is the same as when the - code is run without coverage.py. - -- The `data_suffix` argument to the coverage constructor is now appended with - an added dot rather than simply appended, so that .coveragerc files will not - be confused for data files. - -- Python source files that don't end with a newline can now be executed, fixing - `issue 47`_. - -- Added an AUTHORS.txt file. - -.. _issue 39: https://github.com/nedbat/coveragepy/issues/39 -.. _issue 40: https://github.com/nedbat/coveragepy/issues/40 -.. _issue 47: https://github.com/nedbat/coveragepy/issues/47 - - -.. _changes_32: - -Version 3.2 --- 2009-12-05 --------------------------- - -- Added a ``--version`` option on the command line. - - -Version 3.2b4 --- 2009-12-01 ----------------------------- - -- Branch coverage improvements: - - - The XML report now includes branch information. - -- Click-to-sort HTML report columns are now persisted in a cookie. Viewing - a report will sort it first the way you last had a coverage report sorted. - Thanks, `Chris Adams`_. - -- On Python 3.x, setuptools has been replaced by `Distribute`_. - -.. _Distribute: https://pypi.org/project/distribute/ - - -Version 3.2b3 --- 2009-11-23 ----------------------------- - -- Fixed a memory leak in the C tracer that was introduced in 3.2b1. - -- Branch coverage improvements: - - - Branches to excluded code are ignored. - -- The table of contents in the HTML report is now sortable: click the headers - on any column. Thanks, `Chris Adams`_. - -.. _Chris Adams: http://chris.improbable.org - - -Version 3.2b2 --- 2009-11-19 ----------------------------- - -- Branch coverage improvements: - - - Classes are no longer incorrectly marked as branches: `issue 32`_. - - - "except" clauses with types are no longer incorrectly marked as branches: - `issue 35`_. - -- Fixed some problems syntax coloring sources with line continuations and - source with tabs: `issue 30`_ and `issue 31`_. - -- The --omit option now works much better than before, fixing `issue 14`_ and - `issue 33`_. Thanks, Danek Duvall. - -.. _issue 14: https://github.com/nedbat/coveragepy/issues/14 -.. _issue 30: https://github.com/nedbat/coveragepy/issues/30 -.. _issue 31: https://github.com/nedbat/coveragepy/issues/31 -.. _issue 32: https://github.com/nedbat/coveragepy/issues/32 -.. _issue 33: https://github.com/nedbat/coveragepy/issues/33 -.. _issue 35: https://github.com/nedbat/coveragepy/issues/35 - - -Version 3.2b1 --- 2009-11-10 ----------------------------- - -- Branch coverage! - -- XML reporting has file paths that let Cobertura find the source code. - -- The tracer code has changed, it's a few percent faster. - -- Some exceptions reported by the command line interface have been cleaned up - so that tracebacks inside coverage.py aren't shown. Fixes `issue 23`_. - -.. _issue 23: https://github.com/nedbat/coveragepy/issues/23 - - -.. _changes_31: - -Version 3.1 --- 2009-10-04 --------------------------- - -- Source code can now be read from eggs. Thanks, Ross Lawley. Fixes - `issue 25`_. - -.. _issue 25: https://github.com/nedbat/coveragepy/issues/25 - - -Version 3.1b1 --- 2009-09-27 ----------------------------- - -- Python 3.1 is now supported. - -- Coverage.py has a new command line syntax with sub-commands. This expands - the possibilities for adding features and options in the future. The old - syntax is still supported. Try "coverage help" to see the new commands. - Thanks to Ben Finney for early help. - -- Added an experimental "coverage xml" command for producing coverage reports - in a Cobertura-compatible XML format. Thanks, Bill Hart. - -- Added the --timid option to enable a simpler slower trace function that works - for DecoratorTools projects, including TurboGears. Fixed `issue 12`_ and - `issue 13`_. - -- HTML reports show modules from other directories. Fixed `issue 11`_. - -- HTML reports now display syntax-colored Python source. - -- Programs that change directory will still write .coverage files in the - directory where execution started. Fixed `issue 24`_. - -- Added a "coverage debug" command for getting diagnostic information about the - coverage.py installation. - -.. _issue 11: https://github.com/nedbat/coveragepy/issues/11 -.. _issue 12: https://github.com/nedbat/coveragepy/issues/12 -.. _issue 13: https://github.com/nedbat/coveragepy/issues/13 -.. _issue 24: https://github.com/nedbat/coveragepy/issues/24 - - -.. _changes_301: - -Version 3.0.1 --- 2009-07-07 ----------------------------- - -- Removed the recursion limit in the tracer function. Previously, code that - ran more than 500 frames deep would crash. Fixed `issue 9`_. - -- Fixed a bizarre problem involving pyexpat, whereby lines following XML parser - invocations could be overlooked. Fixed `issue 10`_. - -- 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.py modules will be mentioned in the nose --with-cover plug-in. - 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. - -.. _issue 9: https://github.com/nedbat/coveragepy/issues/9 -.. _issue 10: https://github.com/nedbat/coveragepy/issues/10 -.. _issue 8: https://github.com/nedbat/coveragepy/issues/8 - - -.. _changes_30: - -Version 3.0 --- 2009-06-13 --------------------------- - -- Fixed the way the Python library was ignored. Too much code was being - excluded the old way. - -- Tabs are now properly converted in HTML reports. Previously indentation was - lost. Fixed `issue 6`_. - -- Nested modules now get a proper flat_rootname. Thanks, Christian Heimes. - -.. _issue 6: https://github.com/nedbat/coveragepy/issues/6 - - -Version 3.0b3 --- 2009-05-16 ----------------------------- - -- Added parameters to coverage.__init__ for options that had been set on the - coverage object itself. - -- Added clear_exclude() and get_exclude_list() methods for programmatic - manipulation of the exclude regexes. - -- Added coverage.load() to read previously-saved data from the data file. - -- Improved the finding of code files. For example, .pyc files that have been - installed after compiling are now located correctly. Thanks, Detlev - Offenbach. - -- When using the object API (that is, constructing a coverage() object), data - is no longer saved automatically on process exit. You can re-enable it with - the auto_data=True parameter on the coverage() constructor. The module-level - interface still uses automatic saving. - - -Version 3.0b --- 2009-04-30 ---------------------------- - -HTML reporting, and continued refactoring. - -- HTML reports and annotation of source files: use the new -b (browser) switch. - Thanks to George Song for code, inspiration and guidance. - -- Code in the Python standard library is not measured by default. If you need - to measure standard library code, use the -L command-line switch during - execution, or the cover_pylib=True argument to the coverage() constructor. - -- Source annotation into a directory (-a -d) behaves differently. The - annotated files are named with their hierarchy flattened so that same-named - files from different directories no longer collide. Also, only files in the - current tree are included. - -- coverage.annotate_file is no longer available. - -- Programs executed with -x now behave more as they should, for example, - __file__ has the correct value. - -- .coverage data files have a new pickle-based format designed for better - extensibility. - -- Removed the undocumented cache_file argument to coverage.usecache(). - - -Version 3.0b1 --- 2009-03-07 ----------------------------- - -Major overhaul. - -- Coverage.py is now a package rather than a module. Functionality has been - split into classes. - -- 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.py. - -- The minimum supported Python version is 2.3. - - -Version 2.85 --- 2008-09-14 ---------------------------- - -- Add support for finding source files in eggs. Don't check for - morf's being instances of ModuleType, instead use duck typing so that - pseudo-modules can participate. Thanks, Imri Goldberg. - -- Use os.realpath as part of the fixing of file names so that symlinks won't - confuse things. Thanks, Patrick Mezard. - - -Version 2.80 --- 2008-05-25 ---------------------------- - -- Open files in rU mode to avoid line ending craziness. Thanks, Edward Loper. - - -Version 2.78 --- 2007-09-30 ---------------------------- - -- Don't try to predict whether a file is Python source based on the extension. - Extension-less files are often Pythons scripts. Instead, simply parse the - file and catch the syntax errors. Hat tip to Ben Finney. - - -Version 2.77 --- 2007-07-29 ---------------------------- - -- Better packaging. - - -Version 2.76 --- 2007-07-23 ---------------------------- - -- Now Python 2.5 is *really* fully supported: the body of the new with - statement is counted as executable. - - -Version 2.75 --- 2007-07-22 ---------------------------- - -- Python 2.5 now fully supported. The method of dealing with multi-line - statements is now less sensitive to the exact line that Python reports during - execution. Pass statements are handled specially so that their disappearance - during execution won't throw off the measurement. - - -Version 2.7 --- 2007-07-21 --------------------------- - -- "#pragma: nocover" is excluded by default. - -- Properly ignore docstrings and other constant expressions that appear in the - middle of a function, a problem reported by Tim Leslie. - -- coverage.erase() shouldn't clobber the exclude regex. Change how parallel - mode is invoked, and fix erase() so that it erases the cache when called - programmatically. - -- In reports, ignore code executed from strings, since we can't do anything - useful with it anyway. - -- Better file handling on Linux, thanks Guillaume Chazarain. - -- Better shell support on Windows, thanks Noel O'Boyle. - -- Python 2.2 support maintained, thanks Catherine Proulx. - -- Minor changes to avoid lint warnings. - - -Version 2.6 --- 2006-08-23 --------------------------- - -- Applied Joseph Tate's patch for function decorators. - -- Applied Sigve Tjora and Mark van der Wal's fixes for argument handling. - -- Applied Geoff Bache's parallel mode patch. - -- Refactorings to improve testability. Fixes to command-line logic for parallel - mode and collect. - - -Version 2.5 --- 2005-12-04 --------------------------- - -- Call threading.settrace so that all threads are measured. Thanks Martin - Fuzzey. - -- Add a file argument to report so that reports can be captured to a different - destination. - -- Coverage.py can now measure itself. - -- Adapted Greg Rogers' patch for using relative file names, and sorting and - omitting files to report on. - - -Version 2.2 --- 2004-12-31 --------------------------- - -- Allow for keyword arguments in the module global functions. Thanks, Allen. - - -Version 2.1 --- 2004-12-14 --------------------------- - -- Return 'analysis' to its original behavior and add 'analysis2'. Add a global - for 'annotate', and factor it, adding 'annotate_file'. - - -Version 2.0 --- 2004-12-12 --------------------------- - -Significant code changes. - -- Finding executable statements has been rewritten so that docstrings and - other quirks of Python execution aren't mistakenly identified as missing - lines. - -- Lines can be excluded from consideration, even entire suites of lines. - -- The file system cache of covered lines can be disabled programmatically. - -- Modernized the code. - - -Earlier History ---------------- - -2001-12-04 GDR Created. - -2001-12-06 GDR Added command-line interface and source code annotation. - -2001-12-09 GDR Moved design and interface to separate documents. - -2001-12-10 GDR Open cache file as binary on Windows. Allow simultaneous -e and --x, or -a and -r. - -2001-12-12 GDR Added command-line help. Cache analysis so that it only needs to -be done once when you specify -a and -r. - -2001-12-13 GDR Improved speed while recording. Portable between Python 1.5.2 -and 2.1.1. +Older changes +------------- -2002-01-03 GDR Module-level functions work correctly. +The complete history is available in the `coverage.py docs`__. -2002-01-07 GDR Update sys.path when running a file with the -x option, so that -it matches the value the program would get if it were run on its own. +__ https://coverage.readthedocs.io/en/latest/changes.html diff --git a/doc/changes.rst b/doc/changes.rst index 73d1532ba..6d7bd6587 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -3,4 +3,2838 @@ .. _changes: +.. The recent changes from the top-level file: + .. include:: ../CHANGES.rst + :end-before: endchangesinclude + +.. Older changes here: + +.. _changes_531: + +Version 5.3.1 --- 2020-12-19 +---------------------------- + +- When using ``--source`` on a large source tree, v5.x was slower than previous + versions. This performance regression is now fixed, closing `issue 1037`_. + +- Mysterious SQLite errors can happen on PyPy, as reported in `issue 1010`_. An + immediate retry seems to fix the problem, although it is an unsatisfying + solution. + +- The HTML report now saves the sort order in a more widely supported way, + fixing `issue 986`_. Thanks, Sebastián Ramírez (`pull request 1066`_). + +- The HTML report pages now have a :ref:`Sleepy Snake ` favicon. + +- Wheels are now provided for manylinux2010, and for PyPy3 (pp36 and pp37). + +- Continuous integration has moved from Travis and AppVeyor to GitHub Actions. + +.. _issue 986: https://github.com/nedbat/coveragepy/issues/986 +.. _issue 1037: https://github.com/nedbat/coveragepy/issues/1037 +.. _issue 1010: https://github.com/nedbat/coveragepy/issues/1010 +.. _pull request 1066: https://github.com/nedbat/coveragepy/pull/1066 + +.. _changes_53: + +Version 5.3 --- 2020-09-13 +-------------------------- + +- The ``source`` setting has always been interpreted as either a file path or a + module, depending on which existed. If both interpretations were valid, it + was assumed to be a file path. The new ``source_pkgs`` setting can be used + to name a package to disambiguate this case. Thanks, Thomas Grainger. Fixes + `issue 268`_. + +- If a plugin was disabled due to an exception, we used to still try to record + its information, causing an exception, as reported in `issue 1011`_. This is + now fixed. + +.. _issue 268: https://github.com/nedbat/coveragepy/issues/268 +.. _issue 1011: https://github.com/nedbat/coveragepy/issues/1011 + + +.. _changes_521: + +Version 5.2.1 --- 2020-07-23 +---------------------------- + +- The dark mode HTML report still used light colors for the context listing, + making them unreadable (`issue 1009`_). This is now fixed. + +- The time stamp on the HTML report now includes the time zone. Thanks, Xie + Yanbo (`pull request 960`_). + +.. _pull request 960: https://github.com/nedbat/coveragepy/pull/960 +.. _issue 1009: https://github.com/nedbat/coveragepy/issues/1009 + + +.. _changes_52: + +Version 5.2 --- 2020-07-05 +-------------------------- + +- The HTML report has been redesigned by Vince Salvino. There is now a dark + mode, the code text is larger, and system sans serif fonts are used, in + addition to other small changes (`issue 858`_ and `pull request 931`_). + +- The ``coverage report`` and ``coverage html`` commands now accept a + ``--precision`` option to control the number of decimal points displayed. + Thanks, Teake Nutma (`pull request 982`_). + +- The ``coverage report`` and ``coverage html`` commands now accept a + ``--no-skip-covered`` option to negate ``--skip-covered``. Thanks, Anthony + Sottile (`issue 779`_ and `pull request 932`_). + +- The ``--skip-empty`` option is now available for the XML report, closing + `issue 976`_. + +- The ``coverage report`` command now accepts a ``--sort`` option to specify + how to sort the results. Thanks, Jerin Peter George (`pull request 1005`_). + +- If coverage fails due to the coverage total not reaching the ``--fail-under`` + value, it will now print a message making the condition clear. Thanks, + Naveen Yadav (`pull request 977`_). + +- TOML configuration files with non-ASCII characters would cause errors on + Windows (`issue 990`_). This is now fixed. + +- The output of ``--debug=trace`` now includes information about how the + ``--source`` option is being interpreted, and the module names being + considered. + +.. _pull request 931: https://github.com/nedbat/coveragepy/pull/931 +.. _pull request 932: https://github.com/nedbat/coveragepy/pull/932 +.. _pull request 977: https://github.com/nedbat/coveragepy/pull/977 +.. _pull request 982: https://github.com/nedbat/coveragepy/pull/982 +.. _pull request 1005: https://github.com/nedbat/coveragepy/pull/1005 +.. _issue 779: https://github.com/nedbat/coveragepy/issues/779 +.. _issue 858: https://github.com/nedbat/coveragepy/issues/858 +.. _issue 976: https://github.com/nedbat/coveragepy/issues/976 +.. _issue 990: https://github.com/nedbat/coveragepy/issues/990 + + +.. _changes_51: + +Version 5.1 --- 2020-04-12 +-------------------------- + +- The JSON report now includes counts of covered and missing branches. Thanks, + Salvatore Zagaria. + +- On Python 3.8, try-finally-return reported wrong branch coverage with + decorated async functions (`issue 964`_). This is now fixed. Thanks, Kjell + Braden. + +- The :meth:`~coverage.Coverage.get_option` and + :meth:`~coverage.Coverage.set_option` methods can now manipulate the + ``[paths]`` configuration setting. Thanks to Bernát Gábor for the fix for + `issue 967`_. + +.. _issue 964: https://github.com/nedbat/coveragepy/issues/964 +.. _issue 967: https://github.com/nedbat/coveragepy/issues/967 + + +.. _changes_504: + +Version 5.0.4 --- 2020-03-16 +---------------------------- + +- If using the ``[run] relative_files`` setting, the XML report will use + relative files in the ```` elements indicating the location of source + code. Closes `issue 948`_. + +- The textual summary report could report missing lines with negative line + numbers on PyPy3 7.1 (`issue 943`_). This is now fixed. + +- Windows wheels for Python 3.8 were incorrectly built, but are now fixed. + (`issue 949`_) + +- Updated Python 3.9 support to 3.9a4. + +- HTML reports couldn't be sorted if localStorage wasn't available. This is now + fixed: sorting works even though the sorting setting isn't retained. (`issue + 944`_ and `pull request 945`_). Thanks, Abdeali Kothari. + +.. _issue 943: https://github.com/nedbat/coveragepy/issues/943 +.. _issue 944: https://github.com/nedbat/coveragepy/issues/944 +.. _pull request 945: https://github.com/nedbat/coveragepy/pull/945 +.. _issue 948: https://github.com/nedbat/coveragepy/issues/948 +.. _issue 949: https://github.com/nedbat/coveragepy/issues/949 + + +.. _changes_503: + +Version 5.0.3 --- 2020-01-12 +---------------------------- + +- A performance improvement in 5.0.2 didn't work for test suites that changed + directory before combining data, causing "Couldn't use data file: no such + table: meta" errors (`issue 916`_). This is now fixed. + +- Coverage could fail to run your program with some form of "ModuleNotFound" or + "ImportError" trying to import from the current directory. This would happen + if coverage had been packaged into a zip file (for example, on Windows), or + was found indirectly (for example, by pyenv-virtualenv). A number of + different scenarios were described in `issue 862`_ which is now fixed. Huge + thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and + George-Cristian Bîrzan for protracted debugging sessions. + +- Added the "premain" debug option. + +- Added SQLite compile-time options to the "debug sys" output. + +.. _issue 862: https://github.com/nedbat/coveragepy/issues/862 +.. _issue 916: https://github.com/nedbat/coveragepy/issues/916 + + +.. _changes_502: + +Version 5.0.2 --- 2020-01-05 +---------------------------- + +- Programs that used multiprocessing and changed directories would fail under + coverage. This is now fixed (`issue 890`_). A side effect is that debug + information about the config files read now shows absolute paths to the + files. + +- When running programs as modules (``coverage run -m``) with ``--source``, + some measured modules were imported before coverage starts. This resulted in + unwanted warnings ("Already imported a file that will be measured") and a + reduction in coverage totals (`issue 909`_). This is now fixed. + +- If no data was collected, an exception about "No data to report" could happen + instead of a 0% report being created (`issue 884`_). This is now fixed. + +- The handling of source files with non-encodable file names has changed. + Previously, if a file name could not be encoded as UTF-8, an error occurred, + as described in `issue 891`_. Now, those files will not be measured, since + their data would not be recordable. + +- A new warning ("dynamic-conflict") is issued if two mechanisms are trying to + change the dynamic context. Closes `issue 901`_. + +- ``coverage run --debug=sys`` would fail with an AttributeError. This is now + fixed (`issue 907`_). + +.. _issue 884: https://github.com/nedbat/coveragepy/issues/884 +.. _issue 890: https://github.com/nedbat/coveragepy/issues/890 +.. _issue 891: https://github.com/nedbat/coveragepy/issues/891 +.. _issue 901: https://github.com/nedbat/coveragepy/issues/901 +.. _issue 907: https://github.com/nedbat/coveragepy/issues/907 +.. _issue 909: https://github.com/nedbat/coveragepy/issues/909 + + +.. _changes_501: + +Version 5.0.1 --- 2019-12-22 +---------------------------- + +- If a 4.x data file is the cause of a "file is not a database" error, then use + a more specific error message, "Looks like a coverage 4.x data file, are you + mixing versions of coverage?" Helps diagnose the problems described in + `issue 886`_. + +- Measurement contexts and relative file names didn't work together, as + reported in `issue 899`_ and `issue 900`_. This is now fixed, thanks to + David Szotten. + +- When using ``coverage run --concurrency=multiprocessing``, all data files + should be named with parallel-ready suffixes. 5.0 mistakenly named the main + process' file with no suffix when using ``--append``. This is now fixed, + closing `issue 880`_. + +- Fixed a problem on Windows when the current directory is changed to a + different drive (`issue 895`_). Thanks, Olivier Grisel. + +- Updated Python 3.9 support to 3.9a2. + +.. _issue 880: https://github.com/nedbat/coveragepy/issues/880 +.. _issue 886: https://github.com/nedbat/coveragepy/issues/886 +.. _issue 895: https://github.com/nedbat/coveragepy/issues/895 +.. _issue 899: https://github.com/nedbat/coveragepy/issues/899 +.. _issue 900: https://github.com/nedbat/coveragepy/issues/900 + + +.. _changes_50: + +Version 5.0 --- 2019-12-14 +-------------------------- + +Nothing new beyond 5.0b2. + +A summary of major changes in 5.0 since 4.5.x is in see :ref:`whatsnew5x`. + + + +.. _changes_50b2: + +Version 5.0b2 --- 2019-12-08 +---------------------------- + +- An experimental ``[run] relative_files`` setting tells coverage to store + relative file names in the data file. This makes it easier to run tests in + one (or many) environments, and then report in another. It has not had much + real-world testing, so it may change in incompatible ways in the future. + +- When constructing a :class:`coverage.Coverage` object, `data_file` can be + specified as None to prevent writing any data file at all. In previous + versions, an explicit `data_file=None` argument would use the default of + ".coverage". Fixes `issue 871`_. + +- Python files run with ``-m`` now have ``__spec__`` defined properly. This + fixes `issue 745`_ (about not being able to run unittest tests that spawn + subprocesses), and `issue 838`_, which described the problem directly. + +- The ``[paths]`` configuration section is now ordered. If you specify more + than one list of patterns, the first one that matches will be used. Fixes + `issue 649`_. + +- The :func:`.coverage.numbits.register_sqlite_functions` function now also + registers `numbits_to_nums` for use in SQLite queries. Thanks, Simon + Willison. + +- Python 3.9a1 is supported. + +- Coverage.py has a mascot: :ref:`Sleepy Snake `. + +.. _issue 649: https://github.com/nedbat/coveragepy/issues/649 +.. _issue 745: https://github.com/nedbat/coveragepy/issues/745 +.. _issue 838: https://github.com/nedbat/coveragepy/issues/838 +.. _issue 871: https://github.com/nedbat/coveragepy/issues/871 + + +.. _changes_50b1: + +Version 5.0b1 --- 2019-11-11 +---------------------------- + +- The HTML and textual reports now have a ``--skip-empty`` option that skips + files with no statements, notably ``__init__.py`` files. Thanks, Reya B. + +- Configuration can now be read from `TOML`_ files. This requires installing + coverage.py with the ``[toml]`` extra. The standard "pyproject.toml" file + will be read automatically if no other configuration file is found, with + settings in the ``[tool.coverage.]`` namespace. Thanks to Frazer McLean for + implementation and persistence. Finishes `issue 664`_. + +- The ``[run] note`` setting has been deprecated. Using it will result in a + warning, and the note will not be written to the data file. The + corresponding :class:`.CoverageData` methods have been removed. + +- The HTML report has been reimplemented (no more table around the source + code). This allowed for a better presentation of the context information, + hopefully resolving `issue 855`_. + +- Added sqlite3 module version information to ``coverage debug sys`` output. + +- Asking the HTML report to show contexts (``[html] show_contexts=True`` or + ``coverage html --show-contexts``) will issue a warning if there were no + contexts measured (`issue 851`_). + +.. _TOML: https://toml.io/ +.. _issue 664: https://github.com/nedbat/coveragepy/issues/664 +.. _issue 851: https://github.com/nedbat/coveragepy/issues/851 +.. _issue 855: https://github.com/nedbat/coveragepy/issues/855 + + +.. _changes_50a8: + +Version 5.0a8 --- 2019-10-02 +---------------------------- + +- The :class:`.CoverageData` API has changed how queries are limited to + specific contexts. Now you use :meth:`.CoverageData.set_query_context` to + set a single exact-match string, or :meth:`.CoverageData.set_query_contexts` + to set a list of regular expressions to match contexts. This changes the + command-line ``--contexts`` option to use regular expressions instead of + filename-style wildcards. + + +.. _changes_50a7: + +Version 5.0a7 --- 2019-09-21 +---------------------------- + +- Data can now be "reported" in JSON format, for programmatic use, as requested + in `issue 720`_. The new ``coverage json`` command writes raw and summarized + data to a JSON file. Thanks, Matt Bachmann. + +- Dynamic contexts are now supported in the Python tracer, which is important + for PyPy users. Closes `issue 846`_. + +- The compact line number representation introduced in 5.0a6 is called a + "numbits." The :mod:`coverage.numbits` module provides functions for working + with them. + +- The reporting methods used to permanently apply their arguments to the + configuration of the Coverage object. Now they no longer do. The arguments + affect the operation of the method, but do not persist. + +- A class named "test_something" no longer confuses the ``test_function`` + dynamic context setting. Fixes `issue 829`_. + +- Fixed an unusual tokenizing issue with backslashes in comments. Fixes + `issue 822`_. + +- ``debug=plugin`` didn't properly support configuration or dynamic context + plugins, but now it does, closing `issue 834`_. + +.. _issue 720: https://github.com/nedbat/coveragepy/issues/720 +.. _issue 822: https://github.com/nedbat/coveragepy/issues/822 +.. _issue 834: https://github.com/nedbat/coveragepy/issues/834 +.. _issue 829: https://github.com/nedbat/coveragepy/issues/829 +.. _issue 846: https://github.com/nedbat/coveragepy/issues/846 + + +.. _changes_50a6: + +Version 5.0a6 --- 2019-07-16 +---------------------------- + +- Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas + for the contribution. + + - The ``--contexts`` option is available on the ``report`` and ``html`` + commands. It's a comma-separated list of shell-style wildcards, selecting + the contexts to report on. Only contexts matching one of the wildcards + will be included in the report. + + - The ``--show-contexts`` option for the ``html`` command adds context + information to each covered line. Hovering over the "ctx" marker at the + end of the line reveals a list of the contexts that covered the line. + +- Database changes: + + - Line numbers are now stored in a much more compact way. For each file and + context, a single binary string is stored with a bit per line number. This + greatly improves memory use, but makes ad-hoc use difficult. + + - Dynamic contexts with no data are no longer written to the database. + + - SQLite data storage is now faster. There's no longer a reason to keep the + JSON data file code, so it has been removed. + +- Changes to the :class:`.CoverageData` interface: + + - The new :meth:`.CoverageData.dumps` method serializes the data to a string, + and a corresponding :meth:`.CoverageData.loads` method reconstitutes this + data. The format of the data string is subject to change at any time, and + so should only be used between two installations of the same version of + coverage.py. + + - The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new + argument, `no_disk` (default: False). Setting it to True prevents writing + any data to the disk. This is useful for transient data objects. + +- Added the classmethod :meth:`.Coverage.current` to get the latest started + Coverage instance. + +- Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes + `issue 828`_. + +- Error handling during reporting has changed slightly. All reporting methods + now behave the same. The ``--ignore-errors`` option keeps errors from + stopping the reporting, but files that couldn't parse as Python will always + be reported as warnings. As with other warnings, you can suppress them with + the ``[run] disable_warnings`` configuration setting. + +- Coverage.py no longer fails if the user program deletes its current + directory. Fixes `issue 806`_. Thanks, Dan Hemberger. + +- The scrollbar markers in the HTML report now accurately show the highlighted + lines, regardless of what categories of line are highlighted. + +- The hack to accommodate ShiningPanda_ looking for an obsolete internal data + file has been removed, since ShiningPanda 0.22 fixed it four years ago. + +- The deprecated `Reporter.file_reporters` property has been removed. + +.. _ShiningPanda: https://plugins.jenkins.io/shiningpanda/ +.. _issue 806: https://github.com/nedbat/coveragepy/pull/806 +.. _issue 828: https://github.com/nedbat/coveragepy/issues/828 + + +.. _changes_50a5: + +Version 5.0a5 --- 2019-05-07 +---------------------------- + +- Drop support for Python 3.4 + +- Dynamic contexts can now be set two new ways, both thanks to Justas + Sadzevičius. + + - A plugin can implement a ``dynamic_context`` method to check frames for + whether a new context should be started. See + :ref:`dynamic_context_plugins` for more details. + + - Another tool (such as a test runner) can use the new + :meth:`.Coverage.switch_context` method to explicitly change the context. + +- The ``dynamic_context = test_function`` setting now works with Python 2 + old-style classes, though it only reports the method name, not the class it + was defined on. Closes `issue 797`_. + +- ``fail_under`` values more than 100 are reported as errors. Thanks to Mike + Fiedler for closing `issue 746`_. + +- The "missing" values in the text output are now sorted by line number, so + that missing branches are reported near the other lines they affect. The + values used to show all missing lines, and then all missing branches. + +- Access to the SQLite database used for data storage is now thread-safe. + Thanks, Stephan Richter. This closes `issue 702`_. + +- Combining data stored in SQLite is now about twice as fast, fixing `issue + 761`_. Thanks, Stephan Richter. + +- The ``filename`` attribute on :class:`.CoverageData` objects has been made + private. You can use the ``data_filename`` method to get the actual file + name being used to store data, and the ``base_filename`` method to get the + original filename before parallelizing suffixes were added. This is part of + fixing `issue 708`_. + +- Line numbers in the HTML report now align properly with source lines, even + when Chrome's minimum font size is set, fixing `issue 748`_. Thanks Wen Ye. + +.. _issue 702: https://github.com/nedbat/coveragepy/issues/702 +.. _issue 708: https://github.com/nedbat/coveragepy/issues/708 +.. _issue 746: https://github.com/nedbat/coveragepy/issues/746 +.. _issue 748: https://github.com/nedbat/coveragepy/issues/748 +.. _issue 761: https://github.com/nedbat/coveragepy/issues/761 +.. _issue 797: https://github.com/nedbat/coveragepy/issues/797 + + +.. _changes_50a4: + +Version 5.0a4 --- 2018-11-25 +---------------------------- + +- You can specify the command line to run your program with the ``[run] + command_line`` configuration setting, as requested in `issue 695`_. + +- Coverage will create directories as needed for the data file if they don't + exist, closing `issue 721`_. + +- The ``coverage run`` command has always adjusted the first entry in sys.path, + to properly emulate how Python runs your program. Now this adjustment is + skipped if sys.path[0] is already different than Python's default. This + fixes `issue 715`_. + +- Improvements to context support: + + - The "no such table: meta" error is fixed.: `issue 716`_. + + - Combining data files is now much faster. + +- Python 3.8 (as of today!) passes all tests. + +.. _issue 695: https://github.com/nedbat/coveragepy/issues/695 +.. _issue 715: https://github.com/nedbat/coveragepy/issues/715 +.. _issue 716: https://github.com/nedbat/coveragepy/issues/716 +.. _issue 721: https://github.com/nedbat/coveragepy/issues/721 + + +.. _changes_50a3: + +Version 5.0a3 --- 2018-10-06 +---------------------------- + +- Context support: static contexts let you specify a label for a coverage run, + which is recorded in the data, and retained when you combine files. See + :ref:`contexts` for more information. + +- Dynamic contexts: specifying ``[run] dynamic_context = test_function`` in the + config file will record the test function name as a dynamic context during + execution. This is the core of "Who Tests What" (`issue 170`_). Things to + note: + + - There is no reporting support yet. Use SQLite to query the .coverage file + for information. Ideas are welcome about how reporting could be extended + to use this data. + + - There's a noticeable slow-down before any test is run. + + - Data files will now be roughly N times larger, where N is the number of + tests you have. Combining data files is therefore also N times slower. + + - No other values for ``dynamic_context`` are recognized yet. Let me know + what else would be useful. I'd like to use a pytest plugin to get better + information directly from pytest, for example. + +.. _issue 170: https://github.com/nedbat/coveragepy/issues/170 + +- Environment variable substitution in configuration files now supports two + syntaxes for controlling the behavior of undefined variables: if ``VARNAME`` + is not defined, ``${VARNAME?}`` will raise an error, and ``${VARNAME-default + value}`` will use "default value". + +- Partial support for Python 3.8, which has not yet released an alpha. Fixes + `issue 707`_ and `issue 714`_. + +.. _issue 707: https://github.com/nedbat/coveragepy/issues/707 +.. _issue 714: https://github.com/nedbat/coveragepy/issues/714 + + +.. _changes_50a2: + +Version 5.0a2 --- 2018-09-03 +---------------------------- + +- Coverage's data storage has changed. In version 4.x, .coverage files were + basically JSON. Now, they are SQLite databases. This means the data file + can be created earlier than it used to. A large amount of code was + refactored to support this change. + + - Because the data file is created differently than previous releases, you + may need ``parallel=true`` where you didn't before. + + - The old data format is still available (for now) by setting the environment + variable COVERAGE_STORAGE=json. Please tell me if you think you need to + keep the JSON format. + + - The database schema is guaranteed to change in the future, to support new + features. I'm looking for opinions about making the schema part of the + public API to coverage.py or not. + +- Development moved from `Bitbucket`_ to `GitHub`_. + +- HTML files no longer have trailing and extra whitespace. + +- The sort order in the HTML report is stored in local storage rather than + cookies, closing `issue 611`_. Thanks, Federico Bond. + +- pickle2json, for converting v3 data files to v4 data files, has been removed. + +.. _Bitbucket: https://bitbucket.org +.. _GitHub: https://github.com/nedbat/coveragepy + +.. _issue 611: https://github.com/nedbat/coveragepy/issues/611 + + +.. _changes_50a1: + +Version 5.0a1 --- 2018-06-05 +---------------------------- + +- Coverage.py no longer supports Python 2.6 or 3.3. + +- The location of the configuration file can now be specified with a + ``COVERAGE_RCFILE`` environment variable, as requested in `issue 650`_. + +- Namespace packages are supported on Python 3.7, where they used to cause + TypeErrors about path being None. Fixes `issue 700`_. + +- A new warning (``already-imported``) is issued if measurable files have + already been imported before coverage.py started measurement. See + :ref:`cmd_warnings` for more information. + +- Running coverage many times for small runs in a single process should be + faster, closing `issue 625`_. Thanks, David MacIver. + +- Large HTML report pages load faster. Thanks, Pankaj Pandey. + +.. _issue 625: https://github.com/nedbat/coveragepy/issues/625 +.. _issue 650: https://github.com/nedbat/coveragepy/issues/650 +.. _issue 700: https://github.com/nedbat/coveragepy/issues/700 + + +.. _changes_454: + +Version 4.5.4 --- 2019-07-29 +---------------------------- + +- Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes + `issue 828`_. + +.. _issue 828: https://github.com/nedbat/coveragepy/issues/828 + + +.. _changes_453: + +Version 4.5.3 --- 2019-03-09 +---------------------------- + +- Only packaging metadata changes. + + +.. _changes_452: + +Version 4.5.2 --- 2018-11-12 +---------------------------- + +- Namespace packages are supported on Python 3.7, where they used to cause + TypeErrors about path being None. Fixes `issue 700`_. + +- Python 3.8 (as of today!) passes all tests. Fixes `issue 707`_ and + `issue 714`_. + +- Development moved from `Bitbucket`_ to `GitHub`_. + +.. _issue 700: https://github.com/nedbat/coveragepy/issues/700 +.. _issue 707: https://github.com/nedbat/coveragepy/issues/707 +.. _issue 714: https://github.com/nedbat/coveragepy/issues/714 + +.. _Bitbucket: https://bitbucket.org +.. _GitHub: https://github.com/nedbat/coveragepy + + +.. _changes_451: + +Version 4.5.1 --- 2018-02-10 +---------------------------- + +- Now that 4.5 properly separated the ``[run] omit`` and ``[report] omit`` + settings, an old bug has become apparent. If you specified a package name + for ``[run] source``, then omit patterns weren't matched inside that package. + This bug (`issue 638`_) is now fixed. + +- On Python 3.7, reporting about a decorated function with no body other than a + docstring would crash coverage.py with an IndexError (`issue 640`_). This is + now fixed. + +- Configurer plugins are now reported in the output of ``--debug=sys``. + +.. _issue 638: https://github.com/nedbat/coveragepy/issues/638 +.. _issue 640: https://github.com/nedbat/coveragepy/issues/640 + + +.. _changes_45: + +Version 4.5 --- 2018-02-03 +-------------------------- + +- A new kind of plugin is supported: configurers are invoked at start-up to + allow more complex configuration than the .coveragerc file can easily do. + See :ref:`api_plugin` for details. This solves the complex configuration + problem described in `issue 563`_. + +- The ``fail_under`` option can now be a float. Note that you must specify the + ``[report] precision`` configuration option for the fractional part to be + used. Thanks to Lars Hupfeldt Nielsen for help with the implementation. + Fixes `issue 631`_. + +- The ``include`` and ``omit`` options can be specified for both the ``[run]`` + and ``[report]`` phases of execution. 4.4.2 introduced some incorrect + interactions between those phases, where the options for one were confused + for the other. This is now corrected, fixing `issue 621`_ and `issue 622`_. + Thanks to Daniel Hahler for seeing more clearly than I could. + +- The ``coverage combine`` command used to always overwrite the data file, even + when no data had been read from apparently combinable files. Now, an error + is raised if we thought there were files to combine, but in fact none of them + could be used. Fixes `issue 629`_. + +- The ``coverage combine`` command could get confused about path separators + when combining data collected on Windows with data collected on Linux, as + described in `issue 618`_. This is now fixed: the result path always uses + the path separator specified in the ``[paths]`` result. + +- On Windows, the HTML report could fail when source trees are deeply nested, + due to attempting to create HTML filenames longer than the 250-character + maximum. Now filenames will never get much larger than 200 characters, + fixing `issue 627`_. Thanks to Alex Sandro for helping with the fix. + +.. _issue 563: https://github.com/nedbat/coveragepy/issues/563 +.. _issue 618: https://github.com/nedbat/coveragepy/issues/618 +.. _issue 621: https://github.com/nedbat/coveragepy/issues/621 +.. _issue 622: https://github.com/nedbat/coveragepy/issues/622 +.. _issue 627: https://github.com/nedbat/coveragepy/issues/627 +.. _issue 629: https://github.com/nedbat/coveragepy/issues/629 +.. _issue 631: https://github.com/nedbat/coveragepy/issues/631 + + +.. _changes_442: + +Version 4.4.2 --- 2017-11-05 +---------------------------- + +- Support for Python 3.7. In some cases, class and module docstrings are no + longer counted in statement totals, which could slightly change your total + results. + +- Specifying both ``--source`` and ``--include`` no longer silently ignores the + include setting, instead it displays a warning. Thanks, Loïc Dachary. Closes + `issue 265`_ and `issue 101`_. + +- Fixed a race condition when saving data and multiple threads are tracing + (`issue 581`_). It could produce a "dictionary changed size during iteration" + RuntimeError. I believe this mostly but not entirely fixes the race + condition. A true fix would likely be too expensive. Thanks, Peter Baughman + for the debugging, and Olivier Grisel for the fix with tests. + +- Configuration values which are file paths will now apply tilde-expansion, + closing `issue 589`_. + +- Now secondary config files like tox.ini and setup.cfg can be specified + explicitly, and prefixed sections like `[coverage:run]` will be read. Fixes + `issue 588`_. + +- Be more flexible about the command name displayed by help, fixing + `issue 600`_. Thanks, Ben Finney. + +.. _issue 101: https://github.com/nedbat/coveragepy/issues/101 +.. _issue 581: https://github.com/nedbat/coveragepy/issues/581 +.. _issue 588: https://github.com/nedbat/coveragepy/issues/588 +.. _issue 589: https://github.com/nedbat/coveragepy/issues/589 +.. _issue 600: https://github.com/nedbat/coveragepy/issues/600 + + +.. _changes_441: + +Version 4.4.1 --- 2017-05-14 +---------------------------- + +- No code changes: just corrected packaging for Python 2.7 Linux wheels. + + +.. _changes_44: + +Version 4.4 --- 2017-05-07 +-------------------------- + +- 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 ```` and ```` 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://github.com/nedbat/coveragepy/issues/526 +.. _issue 572: https://github.com/nedbat/coveragepy/issues/572 +.. _issue 573: https://github.com/nedbat/coveragepy/issues/573 +.. _issue 575: https://github.com/nedbat/coveragepy/issues/575 + + +Version 4.4b1 --- 2017-04-04 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/79 +.. _issue 96: https://github.com/nedbat/coveragepy/issues/96 +.. _issue 355: https://github.com/nedbat/coveragepy/issues/355 +.. _issue 448: https://github.com/nedbat/coveragepy/issues/448 +.. _issue 570: https://github.com/nedbat/coveragepy/issues/570 + + +.. _changes_434: + +Version 4.3.4 --- 2017-01-17 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/556 + + +.. _changes_433: + +Version 4.3.3 --- 2017-01-17 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/554 + + +.. _changes_432: + +Version 4.3.2 --- 2017-01-16 +---------------------------- + +- 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 achieved 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://github.com/nedbat/coveragepy/issues/322 +.. _issue 426: https://github.com/nedbat/coveragepy/issues/426 +.. _issue 522: https://github.com/nedbat/coveragepy/issues/522 +.. _issue 549: https://github.com/nedbat/coveragepy/issues/549 +.. _issue 551: https://github.com/nedbat/coveragepy/issues/551 + + +.. _changes_431: + +Version 4.3.1 --- 2016-12-28 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/540 +.. _issue 541: https://github.com/nedbat/coveragepy/issues/541 + + +.. _changes_43: + +Version 4.3 --- 2016-12-27 +-------------------------- + +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.html#sys.excepthook +.. _issue 265: https://github.com/nedbat/coveragepy/issues/265 +.. _issue 412: https://github.com/nedbat/coveragepy/issues/412 +.. _issue 433: https://github.com/nedbat/coveragepy/issues/433 +.. _issue 493: https://github.com/nedbat/coveragepy/issues/493 +.. _issue 496: https://github.com/nedbat/coveragepy/issues/496 +.. _issue 502: https://github.com/nedbat/coveragepy/issues/502 +.. _issue 505: https://github.com/nedbat/coveragepy/issues/505 +.. _issue 514: https://github.com/nedbat/coveragepy/issues/514 +.. _issue 510: https://github.com/nedbat/coveragepy/issues/510 +.. _issue 511: https://github.com/nedbat/coveragepy/issues/511 +.. _issue 516: https://github.com/nedbat/coveragepy/issues/516 +.. _issue 519: https://github.com/nedbat/coveragepy/issues/519 +.. _issue 524: https://github.com/nedbat/coveragepy/issues/524 +.. _issue 525: https://github.com/nedbat/coveragepy/issues/525 +.. _issue 529: https://github.com/nedbat/coveragepy/issues/529 +.. _issue 530: https://github.com/nedbat/coveragepy/issues/530 +.. _issue 533: https://github.com/nedbat/coveragepy/issues/533 +.. _issue 535: https://github.com/nedbat/coveragepy/issues/535 + + +.. _changes_42: + +Version 4.2 --- 2016-07-26 +-------------------------- + +- 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://github.com/nedbat/coveragepy/issues/495 + + +Version 4.2b1 --- 2016-07-04 +---------------------------- + +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: https://coverage.readthedocs.io/en/latest/subprocess.html +.. _issue 199: https://github.com/nedbat/coveragepy/issues/199 +.. _issue 231: https://github.com/nedbat/coveragepy/issues/231 +.. _issue 298: https://github.com/nedbat/coveragepy/issues/298 +.. _issue 396: https://github.com/nedbat/coveragepy/issues/396 +.. _issue 454: https://github.com/nedbat/coveragepy/issues/454 +.. _issue 478: https://github.com/nedbat/coveragepy/issues/478 +.. _issue 484: https://github.com/nedbat/coveragepy/issues/484 +.. _issue 492: https://github.com/nedbat/coveragepy/issues/492 +.. _unittest-mixins: https://pypi.org/project/unittest-mixins/ + + +.. _changes_41: + +Version 4.1 --- 2016-05-21 +-------------------------- + +- 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. + + +Version 4.1b3 --- 2016-05-10 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/90 +.. _issue 245: https://github.com/nedbat/coveragepy/issues/245 +.. _issue 440: https://github.com/nedbat/coveragepy/issues/440 +.. _issue 456: https://github.com/nedbat/coveragepy/issues/456 +.. _issue 460: https://github.com/nedbat/coveragepy/issues/460 +.. _issue 469: https://github.com/nedbat/coveragepy/issues/469 +.. _issue 472: https://github.com/nedbat/coveragepy/issues/472 +.. _issue 475: https://github.com/nedbat/coveragepy/issues/475 +.. _issue 479: https://github.com/nedbat/coveragepy/issues/479 +.. _issue 481: https://github.com/nedbat/coveragepy/issues/481 +.. _issue 485: https://github.com/nedbat/coveragepy/issues/485 + + +Version 4.1b2 --- 2016-01-23 +---------------------------- + +- Problems with the new branch measurement in 4.1 beta 1 were fixed: + + - Class docstrings were considered executable. Now they no longer are. + + - ``yield from`` and ``await`` were considered returns from functions, since + they could transfer control to the caller. This produced unhelpful + "missing branch" reports in a number of circumstances. Now they no longer + are considered returns. + + - In unusual situations, a missing branch to a negative number was reported. + This has been fixed, closing `issue 466`_. + +- The XML report now produces correct package names for modules found in + directories specified with ``source=``. Fixes `issue 465`_. + +- ``coverage report`` won't produce trailing whitespace. + +.. _issue 465: https://github.com/nedbat/coveragepy/issues/465 +.. _issue 466: https://github.com/nedbat/coveragepy/issues/466 + + +Version 4.1b1 --- 2016-01-10 +---------------------------- + +- Branch analysis has been rewritten: it used to be based on bytecode, but now + uses AST analysis. This has changed a number of things: + + - More code paths are now considered runnable, especially in + ``try``/``except`` structures. This may mean that coverage.py will + identify more code paths as uncovered. This could either raise or lower + your overall coverage number. + + - Python 3.5's ``async`` and ``await`` keywords are properly supported, + fixing `issue 434`_. + + - Some long-standing branch coverage bugs were fixed: + + - `issue 129`_: functions with only a docstring for a body would + incorrectly report a missing branch on the ``def`` line. + + - `issue 212`_: code in an ``except`` block could be incorrectly marked as + a missing branch. + + - `issue 146`_: context managers (``with`` statements) in a loop or ``try`` + block could confuse the branch measurement, reporting incorrect partial + branches. + + - `issue 422`_: in Python 3.5, an actual partial branch could be marked as + complete. + +- Pragmas to disable coverage measurement can now be used on decorator lines, + and they will apply to the entire function or class being decorated. This + implements the feature requested in `issue 131`_. + +- Multiprocessing support is now available on Windows. Thanks, Rodrigue + Cloutier. + +- Files with two encoding declarations are properly supported, fixing + `issue 453`_. Thanks, Max Linke. + +- Non-ascii characters in regexes in the configuration file worked in 3.7, but + stopped working in 4.0. Now they work again, closing `issue 455`_. + +- Form-feed characters would prevent accurate determination of the beginning of + statements in the rest of the file. This is now fixed, closing `issue 461`_. + +.. _issue 129: https://github.com/nedbat/coveragepy/issues/129 +.. _issue 131: https://github.com/nedbat/coveragepy/issues/131 +.. _issue 146: https://github.com/nedbat/coveragepy/issues/146 +.. _issue 212: https://github.com/nedbat/coveragepy/issues/212 +.. _issue 422: https://github.com/nedbat/coveragepy/issues/422 +.. _issue 434: https://github.com/nedbat/coveragepy/issues/434 +.. _issue 453: https://github.com/nedbat/coveragepy/issues/453 +.. _issue 455: https://github.com/nedbat/coveragepy/issues/455 +.. _issue 461: https://github.com/nedbat/coveragepy/issues/461 + + +.. _changes_403: + +Version 4.0.3 --- 2015-11-24 +---------------------------- + +- Fixed a mysterious problem that manifested in different ways: sometimes + hanging the process (`issue 420`_), sometimes making database connections + fail (`issue 445`_). + +- The XML report now has correct ```` elements when using a + ``--source=`` option somewhere besides the current directory. This fixes + `issue 439`_. Thanks, Arcadiy Ivanov. + +- Fixed an unusual edge case of detecting source encodings, described in + `issue 443`_. + +- Help messages that mention the command to use now properly use the actual + command name, which might be different than "coverage". Thanks to Ben + Finney, this closes `issue 438`_. + +.. _issue 420: https://github.com/nedbat/coveragepy/issues/420 +.. _issue 438: https://github.com/nedbat/coveragepy/issues/438 +.. _issue 439: https://github.com/nedbat/coveragepy/issues/439 +.. _issue 443: https://github.com/nedbat/coveragepy/issues/443 +.. _issue 445: https://github.com/nedbat/coveragepy/issues/445 + + +.. _changes_402: + +Version 4.0.2 --- 2015-11-04 +---------------------------- + +- More work on supporting unusually encoded source. Fixed `issue 431`_. + +- Files or directories with non-ASCII characters are now handled properly, + fixing `issue 432`_. + +- Setting a trace function with sys.settrace was broken by a change in 4.0.1, + as reported in `issue 436`_. This is now fixed. + +- Officially support PyPy 4.0, which required no changes, just updates to the + docs. + +.. _issue 431: https://github.com/nedbat/coveragepy/issues/431 +.. _issue 432: https://github.com/nedbat/coveragepy/issues/432 +.. _issue 436: https://github.com/nedbat/coveragepy/issues/436 + + +.. _changes_401: + +Version 4.0.1 --- 2015-10-13 +---------------------------- + +- When combining data files, unreadable files will now generate a warning + instead of failing the command. This is more in line with the older + coverage.py v3.7.1 behavior, which silently ignored unreadable files. + Prompted by `issue 418`_. + +- The --skip-covered option would skip reporting on 100% covered files, but + also skipped them when calculating total coverage. This was wrong, it should + only remove lines from the report, not change the final answer. This is now + fixed, closing `issue 423`_. + +- In 4.0, the data file recorded a summary of the system on which it was run. + Combined data files would keep all of those summaries. This could lead to + enormous data files consisting of mostly repetitive useless information. That + summary is now gone, fixing `issue 415`_. If you want summary information, + get in touch, and we'll figure out a better way to do it. + +- Test suites that mocked os.path.exists would experience strange failures, due + to coverage.py using their mock inadvertently. This is now fixed, closing + `issue 416`_. + +- Importing a ``__init__`` module explicitly would lead to an error: + ``AttributeError: 'module' object has no attribute '__path__'``, as reported + in `issue 410`_. This is now fixed. + +- Code that uses ``sys.settrace(sys.gettrace())`` used to incur a more than 2x + speed penalty. Now there's no penalty at all. Fixes `issue 397`_. + +- Pyexpat C code will no longer be recorded as a source file, fixing + `issue 419`_. + +- The source kit now contains all of the files needed to have a complete source + tree, re-fixing `issue 137`_ and closing `issue 281`_. + +.. _issue 281: https://github.com/nedbat/coveragepy/issues/281 +.. _issue 397: https://github.com/nedbat/coveragepy/issues/397 +.. _issue 410: https://github.com/nedbat/coveragepy/issues/410 +.. _issue 415: https://github.com/nedbat/coveragepy/issues/415 +.. _issue 416: https://github.com/nedbat/coveragepy/issues/416 +.. _issue 418: https://github.com/nedbat/coveragepy/issues/418 +.. _issue 419: https://github.com/nedbat/coveragepy/issues/419 +.. _issue 423: https://github.com/nedbat/coveragepy/issues/423 + + +.. _changes_40: + +Version 4.0 --- 2015-09-20 +-------------------------- + +No changes from 4.0b3 + + +Version 4.0b3 --- 2015-09-07 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/403 +.. _issue 404: https://github.com/nedbat/coveragepy/issues/404 + + +Version 4.0b2 --- 2015-08-22 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/392 +.. _issue 395: https://github.com/nedbat/coveragepy/issues/395 +.. _issue 399: https://github.com/nedbat/coveragepy/issues/399 +.. _sys.version_info: https://docs.python.org/3/library/sys.html#sys.version_info + + +Version 4.0b1 --- 2015-08-02 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/236 +.. _issue 252: https://github.com/nedbat/coveragepy/issues/252 +.. _issue 262: https://github.com/nedbat/coveragepy/issues/262 +.. _issue 275: https://github.com/nedbat/coveragepy/issues/275 +.. _issue 313: https://github.com/nedbat/coveragepy/issues/313 +.. _issue 380: https://github.com/nedbat/coveragepy/issues/380 +.. _issue 385: https://github.com/nedbat/coveragepy/issues/385 +.. _issue 386: https://github.com/nedbat/coveragepy/issues/386 +.. _issue 387: https://github.com/nedbat/coveragepy/issues/387 + +.. 40 issues closed in 4.0 below here + + +Version 4.0a6 --- 2015-06-21 +---------------------------- + +- Python 3.5b2 and PyPy 2.6.0 are supported. + +- 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 `_. + +- 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://github.com/nedbat/coveragepy/issues/299 +.. _issue 308: https://github.com/nedbat/coveragepy/issues/308 +.. _issue 324: https://github.com/nedbat/coveragepy/issues/324 +.. _issue 351: https://github.com/nedbat/coveragepy/issues/351 +.. _issue 354: https://github.com/nedbat/coveragepy/issues/354 +.. _issue 359: https://github.com/nedbat/coveragepy/issues/359 +.. _issue 360: https://github.com/nedbat/coveragepy/issues/360 +.. _issue 361: https://github.com/nedbat/coveragepy/issues/361 +.. _issue 363: https://github.com/nedbat/coveragepy/issues/363 +.. _issue 374: https://github.com/nedbat/coveragepy/issues/374 +.. _issue 375: https://github.com/nedbat/coveragepy/issues/375 + + +Version 4.0a5 --- 2015-02-16 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/117 +.. _issue 340: https://github.com/nedbat/coveragepy/issues/340 +.. _issue 353: https://github.com/nedbat/coveragepy/issues/353 +.. _issue 357: https://github.com/nedbat/coveragepy/issues/357 +.. _issue 358: https://github.com/nedbat/coveragepy/issues/358 + + +Version 4.0a4 --- 2015-01-25 +---------------------------- + +- Plugins can now provide sys_info for debugging output. + +- Started plugins documentation. + +- Prepared to move the docs to readthedocs.org. + + +Version 4.0a3 --- 2015-01-20 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/69 +.. _issue 235: https://github.com/nedbat/coveragepy/issues/235 +.. _issue 290: https://github.com/nedbat/coveragepy/issues/290 +.. _issue 345: https://github.com/nedbat/coveragepy/issues/345 +.. _issue 349: https://github.com/nedbat/coveragepy/issues/349 + + +Version 4.0a2 --- 2015-01-14 +---------------------------- + +- 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://github.com/nedbat/coveragepy/issues/237 +.. _issue 287: https://github.com/nedbat/coveragepy/issues/287 +.. _issue 293: https://github.com/nedbat/coveragepy/issues/293 +.. _issue 314: https://github.com/nedbat/coveragepy/issues/314 +.. _issue 315: https://github.com/nedbat/coveragepy/issues/315 +.. _issue 328: https://github.com/nedbat/coveragepy/issues/328 +.. _issue 334: https://github.com/nedbat/coveragepy/issues/334 +.. _issue 342: https://github.com/nedbat/coveragepy/issues/342 +.. _issue 343: https://github.com/nedbat/coveragepy/issues/343 + + +Version 4.0a1 --- 2014-09-27 +---------------------------- + +- 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 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://github.com/nedbat/coveragepy/issues/57 +.. _issue 94: https://github.com/nedbat/coveragepy/issues/94 +.. _issue 149: https://github.com/nedbat/coveragepy/issues/149 +.. _issue 230: https://github.com/nedbat/coveragepy/issues/230 +.. _issue 284: https://github.com/nedbat/coveragepy/issues/284 +.. _issue 285: https://github.com/nedbat/coveragepy/issues/285 +.. _issue 303: https://github.com/nedbat/coveragepy/issues/303 +.. _issue 304: https://github.com/nedbat/coveragepy/issues/304 +.. _issue 305: https://github.com/nedbat/coveragepy/issues/305 +.. _issue 331: https://github.com/nedbat/coveragepy/issues/331 + + +.. _changes_371: + +Version 3.7.1 --- 2013-12-13 +---------------------------- + +- 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. + + +.. _changes_37: + +Version 3.7 --- 2013-10-06 +-------------------------- + +- 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.py can now run .pyc files directly, closing `issue 264`_. + +- 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. + +- When specifying paths to alias together during data combining, you can now + specify relative paths, fixing `issue 267`_. + +- Most file paths can now be specified with username expansion (``~/src``, or + ``~build/src``, for example), and with environment variable expansion + (``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.py no + longer issues a spurious warning about the trace function changing: "Trace + 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 + decoded properly. Now they are. Thanks, Roger Hu. + +- The source kit now includes the ``__main__.py`` file in the root coverage + directory, fixing `issue 255`_. + +.. _issue 92: https://github.com/nedbat/coveragepy/issues/92 +.. _issue 164: https://github.com/nedbat/coveragepy/issues/164 +.. _issue 175: https://github.com/nedbat/coveragepy/issues/175 +.. _issue 207: https://github.com/nedbat/coveragepy/issues/207 +.. _issue 242: https://github.com/nedbat/coveragepy/issues/242 +.. _issue 218: https://github.com/nedbat/coveragepy/issues/218 +.. _issue 250: https://github.com/nedbat/coveragepy/issues/250 +.. _issue 255: https://github.com/nedbat/coveragepy/issues/255 +.. _issue 259: https://github.com/nedbat/coveragepy/issues/259 +.. _issue 261: https://github.com/nedbat/coveragepy/issues/261 +.. _issue 264: https://github.com/nedbat/coveragepy/issues/264 +.. _issue 267: https://github.com/nedbat/coveragepy/issues/267 + + +.. _changes_36: + +Version 3.6 --- 2013-01-05 +-------------------------- + +- Added a page to the docs about troublesome situations, closing `issue 226`_, + and added some info to the TODO file, closing `issue 227`_. + +.. _issue 226: https://github.com/nedbat/coveragepy/issues/226 +.. _issue 227: https://github.com/nedbat/coveragepy/issues/227 + + +Version 3.6b3 --- 2012-12-29 +---------------------------- + +- Beta 2 broke the nose plugin. It's fixed again, closing `issue 224`_. + +.. _issue 224: https://github.com/nedbat/coveragepy/issues/224 + + +Version 3.6b2 --- 2012-12-23 +---------------------------- + +- Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1. + +- The C extension is optionally compiled using a different more widely-used + technique, taking another stab at fixing `issue 80`_ once and for all. + +- Combining data files would create entries for phantom files if used with + ``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 + file name, coverage.py no longer associates it with the directory name, + fixing `issue 221`_. + +.. _issue 221: https://github.com/nedbat/coveragepy/issues/221 + + +Version 3.6b1 --- 2012-11-28 +---------------------------- + +- Wildcards in ``include=`` and ``omit=`` arguments were not handled properly + in reporting functions, though they were when running. Now they are handled + uniformly, closing `issue 143`_ and `issue 163`_. **NOTE**: it is possible + that your configurations may now be incorrect. If you use ``include`` or + ``omit`` during reporting, whether on the command line, through the API, or + in a configuration file, please check carefully that you were not relying on + the old broken behavior. + +- The **report**, **html**, and **xml** commands now accept a ``--fail-under`` + switch that indicates in the exit status whether the coverage percentage was + less than a particular value. Closes `issue 139`_. + +- The reporting functions coverage.report(), coverage.html_report(), and + coverage.xml_report() now all return a float, the total percentage covered + measurement. + +- The HTML report's title can now be set in the configuration file, with the + ``--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 + didn't work. Now it does. + +- 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 + correctly have 0% coverage, fixing `issue 156`_. This also means that your + total coverage numbers will generally now be lower if you are measuring + branch coverage. + +- When installing, now in addition to creating a "coverage" command, two new + aliases are also installed. A "coverage2" or "coverage3" command will be + created, depending on whether you are installing in Python 2.x or 3.x. + A "coverage-X.Y" command will also be created corresponding to your specific + version of Python. Closes `issue 111`_. + +- The coverage.py installer no longer tries to bootstrap setuptools or + Distribute. You must have one of them installed first, as `issue 202`_ + recommended. + +- The coverage.py kit now includes docs (closing `issue 137`_) and tests. + +- On Windows, files are now reported in their correct case, fixing `issue 89`_ + and `issue 203`_. + +- If a file is missing during reporting, the path shown in the error message + is now correct, rather than an incorrect path in the current directory. + Fixes `issue 60`_. + +- Running an HTML report in Python 3 in the same directory as an old Python 2 + HTML report would fail with a UnicodeDecodeError. This issue (`issue 193`_) + is now fixed. + +- Fixed yet another error trying to parse non-Python files as Python, this + time an IndentationError, closing `issue 82`_ for the fourth time... + +- 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.py under a debugger is unlikely to work, but it shouldn't + 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 documentation for the class `coverage.coverage`. + Closes `issue 206`_. + +- Added a page to the docs about contributing to coverage.py, closing + `issue 171`_. + +- When coverage.py ended unsuccessfully, it may have reported odd errors like + ``'NoneType' object has no attribute 'isabs'``. It no longer does, + so kiss `issue 153`_ goodbye. + +.. _issue 60: https://github.com/nedbat/coveragepy/issues/60 +.. _issue 67: https://github.com/nedbat/coveragepy/issues/67 +.. _issue 89: https://github.com/nedbat/coveragepy/issues/89 +.. _issue 97: https://github.com/nedbat/coveragepy/issues/97 +.. _issue 100: https://github.com/nedbat/coveragepy/issues/100 +.. _issue 111: https://github.com/nedbat/coveragepy/issues/111 +.. _issue 137: https://github.com/nedbat/coveragepy/issues/137 +.. _issue 139: https://github.com/nedbat/coveragepy/issues/139 +.. _issue 143: https://github.com/nedbat/coveragepy/issues/143 +.. _issue 153: https://github.com/nedbat/coveragepy/issues/153 +.. _issue 156: https://github.com/nedbat/coveragepy/issues/156 +.. _issue 163: https://github.com/nedbat/coveragepy/issues/163 +.. _issue 171: https://github.com/nedbat/coveragepy/issues/171 +.. _issue 193: https://github.com/nedbat/coveragepy/issues/193 +.. _issue 201: https://github.com/nedbat/coveragepy/issues/201 +.. _issue 202: https://github.com/nedbat/coveragepy/issues/202 +.. _issue 203: https://github.com/nedbat/coveragepy/issues/203 +.. _issue 205: https://github.com/nedbat/coveragepy/issues/205 +.. _issue 206: https://github.com/nedbat/coveragepy/issues/206 +.. _issue 210: https://github.com/nedbat/coveragepy/issues/210 +.. _issue 214: https://github.com/nedbat/coveragepy/issues/214 + + +.. _changes_353: + +Version 3.5.3 --- 2012-09-29 +---------------------------- + +- 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 sub-directories do, + 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 + then not being able to parse them as Python. Closes `issue 82`_ (again). + Thanks, Julian Berman. + +- Fixed memory leaks under Python 3, thanks, Brett Cannon. Closes `issue 147`_. + +- Optimized .pyo files may not have been handled correctly, `issue 195`_. + Thanks, Marius Gedminas. + +- Certain unusually named file paths could have been mangled during reporting, + `issue 194`_. Thanks, Marius Gedminas. + +- 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 147: https://github.com/nedbat/coveragepy/issues/147 +.. _issue 179: https://github.com/nedbat/coveragepy/issues/179 +.. _issue 183: https://github.com/nedbat/coveragepy/issues/183 +.. _issue 194: https://github.com/nedbat/coveragepy/issues/194 +.. _issue 195: https://github.com/nedbat/coveragepy/issues/195 +.. _issue 197: https://github.com/nedbat/coveragepy/issues/197 +.. _tox: https://tox.readthedocs.io/ + + +.. _changes_352: + +Version 3.5.2 --- 2012-05-04 +---------------------------- + +No changes since 3.5.2.b1 + + +Version 3.5.2b1 --- 2012-04-29 +------------------------------ + +- 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. + +- 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 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 specified as ``show_missing`` in the + config file. Closes `issue 173`_. + +- When running a module with ``coverage run -m ``, certain details + of the execution environment weren't the same as for + ``python -m ``. This had the unfortunate side-effect of making + ``coverage run -m unittest discover`` not work if you had tests in a + directory named "test". This fixes `issue 155`_ and `issue 142`_. + +- Now the exit status of your product code is properly used as the process + 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 142: https://github.com/nedbat/coveragepy/issues/142 +.. _issue 155: https://github.com/nedbat/coveragepy/issues/155 +.. _issue 157: https://github.com/nedbat/coveragepy/issues/157 +.. _issue 166: https://github.com/nedbat/coveragepy/issues/166 +.. _issue 168: https://github.com/nedbat/coveragepy/issues/168 +.. _issue 173: https://github.com/nedbat/coveragepy/issues/173 + + +.. _changes_351: + +Version 3.5.1 --- 2011-09-23 +---------------------------- + +- The ``[paths]`` feature unfortunately didn't work in real world situations + where you wanted to, you know, report on the combined data. Now all paths + stored in the combined file are canonicalized properly. + + +Version 3.5.1b1 --- 2011-08-28 +------------------------------ + +- When combining data files from parallel runs, you can now instruct + coverage.py about which directories are equivalent on different machines. A + ``[paths]`` section in the configuration file lists paths that are to be + 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`_. + +- The number of partial branches reported on the HTML summary page was + 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 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.py code before anything else in the process. + See the coverage/fullcoverage directory if you are interested. + +.. _issue 17: https://github.com/nedbat/coveragepy/issues/17 +.. _issue 122: https://github.com/nedbat/coveragepy/issues/122 +.. _issue 124: https://github.com/nedbat/coveragepy/issues/124 +.. _issue 128: https://github.com/nedbat/coveragepy/issues/128 +.. _issue 138: https://github.com/nedbat/coveragepy/issues/138 +.. _issue 144: https://github.com/nedbat/coveragepy/issues/144 + + +.. _changes_35: + +Version 3.5 --- 2011-06-29 +-------------------------- + +- The HTML report hotkeys now behave slightly differently when the current + chunk isn't visible at all: a chunk on the screen will be selected, + instead of the old behavior of jumping to the literal next chunk. + The hotkeys now work in Google Chrome. Thanks, Guido van Rossum. + + +Version 3.5b1 --- 2011-06-05 +---------------------------- + +- The HTML report now has hotkeys. Try ``n``, ``s``, ``m``, ``x``, ``b``, + ``p``, and ``c`` on the overview page to change the column sorting. + On a file page, ``r``, ``m``, ``x``, and ``p`` toggle the run, missing, + excluded, and partial line markings. You can navigate the highlighted + sections of code by using the ``j`` and ``k`` keys for next and previous. + The ``1`` (one) key jumps to the first highlighted section in the file, + and ``0`` (zero) scrolls to the top of the file. + +- The ``--omit`` and ``--include`` switches now interpret their values more + usefully. If the value starts with a wildcard character, it is used as-is. + If it does not, it is interpreted relative to the current directory. + Closes `issue 121`_. + +- Partial branch warnings can now be pragma'd away. The configuration option + ``partial_branches`` is a list of regular expressions. Lines matching any of + those expressions will never be marked as a partial branch. In addition, + there's a built-in list of regular expressions marking statements which + should never be marked as partial. This list includes ``while True:``, + ``while 1:``, ``if 1:``, and ``if 0:``. + +- The ``coverage()`` constructor accepts single strings for the ``omit=`` and + ``include=`` arguments, adapting to a common error in programmatic use. + +- Modules can now be run directly using ``coverage run -m modulename``, to + mirror Python's ``-m`` flag. Closes `issue 95`_, thanks, Brandon Rhodes. + +- ``coverage run`` didn't emulate Python accurately in one small detail: the + current directory inserted into ``sys.path`` was relative rather than + absolute. This is now fixed. + +- HTML reporting is now incremental: a record is kept of the data that + produced the HTML reports, and only files whose data has changed will + be generated. This should make most HTML reporting faster. + +- Pathological code execution could disable the trace function behind our + backs, leading to incorrect code measurement. Now if this happens, + coverage.py will issue a warning, at least alerting you to the problem. + Closes `issue 93`_. Thanks to Marius Gedminas for the idea. + +- The C-based trace function now behaves properly when saved and restored + with ``sys.gettrace()`` and ``sys.settrace()``. This fixes `issue 125`_ + and `issue 123`_. Thanks, Devin Jeanpierre. + +- Source files are now opened with Python 3.2's ``tokenize.open()`` where + possible, to get the best handling of Python source files with encodings. + Closes `issue 107`_, thanks, Brett Cannon. + +- Syntax errors in supposed Python files can now be ignored during reporting + with the ``-i`` switch just like other source errors. Closes `issue 115`_. + +- Installation from source now succeeds on machines without a C compiler, + closing `issue 80`_. + +- Coverage.py can now be run directly from a working tree by specifying + the directory name to python: ``python coverage_py_working_dir run ...``. + Thanks, Brett Cannon. + +- A little bit of Jython support: `coverage run` can now measure Jython + execution by adapting when $py.class files are traced. Thanks, Adi Roiban. + Jython still doesn't provide the Python libraries needed to make + coverage reporting work, unfortunately. + +- Internally, files are now closed explicitly, fixing `issue 104`_. Thanks, + Brett Cannon. + +.. _issue 80: https://github.com/nedbat/coveragepy/issues/80 +.. _issue 93: https://github.com/nedbat/coveragepy/issues/93 +.. _issue 95: https://github.com/nedbat/coveragepy/issues/95 +.. _issue 104: https://github.com/nedbat/coveragepy/issues/104 +.. _issue 107: https://github.com/nedbat/coveragepy/issues/107 +.. _issue 115: https://github.com/nedbat/coveragepy/issues/115 +.. _issue 121: https://github.com/nedbat/coveragepy/issues/121 +.. _issue 123: https://github.com/nedbat/coveragepy/issues/123 +.. _issue 125: https://github.com/nedbat/coveragepy/issues/125 + + +.. _changes_34: + +Version 3.4 --- 2010-09-19 +-------------------------- + +- The XML report is now sorted by package name, fixing `issue 88`_. + +- Programs that exited with ``sys.exit()`` with no argument weren't handled + properly, producing a coverage.py stack trace. That is now fixed. + +.. _issue 88: https://github.com/nedbat/coveragepy/issues/88 + + +Version 3.4b2 --- 2010-09-06 +---------------------------- + +- Completely unexecuted files can now be included in coverage results, reported + as 0% covered. This only happens if the --source option is specified, since + coverage.py needs guidance about where to look for source files. + +- The XML report output now properly includes a percentage for branch coverage, + fixing `issue 65`_ and `issue 81`_. + +- Coverage percentages are now displayed uniformly across reporting methods. + Previously, different reports could round percentages differently. Also, + percentages are only reported as 0% or 100% if they are truly 0 or 100, and + are rounded otherwise. Fixes `issue 41`_ and `issue 70`_. + +- The precision of reported coverage percentages can be set with the + ``[report] precision`` config file setting. Completes `issue 16`_. + +- Threads derived from ``threading.Thread`` with an overridden `run` method + would report no coverage for the `run` method. This is now fixed, closing + `issue 85`_. + +.. _issue 16: https://github.com/nedbat/coveragepy/issues/16 +.. _issue 41: https://github.com/nedbat/coveragepy/issues/41 +.. _issue 65: https://github.com/nedbat/coveragepy/issues/65 +.. _issue 70: https://github.com/nedbat/coveragepy/issues/70 +.. _issue 81: https://github.com/nedbat/coveragepy/issues/81 +.. _issue 85: https://github.com/nedbat/coveragepy/issues/85 + + +Version 3.4b1 --- 2010-08-21 +---------------------------- + +- 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 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. + +- Various warnings are printed to stderr for problems encountered during data + measurement: if a ``--source`` module has no Python source to measure, or is + never encountered at all, or if no data is collected. + +- The reporting commands (report, annotate, html, and xml) now have an + ``--include`` switch to restrict reporting to modules matching those file + patterns, similar to the existing ``--omit`` switch. Thanks, Zooko. + +- The run command now supports ``--include`` and ``--omit`` to control what + modules it measures. This can speed execution and reduce the amount of data + during reporting. Thanks Zooko. + +- Since coverage.py 3.1, using the Python trace function has been slower than + it needs to be. A cache of tracing decisions was broken, but has now been + fixed. + +- Python 2.7 and 3.2 have introduced new opcodes that are now supported. + +- Python files with no statements, for example, empty ``__init__.py`` files, + are now reported as having zero statements instead of one. Fixes `issue 1`_. + +- Reports now have a column of missed line counts rather than executed line + counts, since developers should focus on reducing the missed lines to zero, + rather than increasing the executed lines to varying targets. Once + suggested, this seemed blindingly obvious. + +- Line numbers in HTML source pages are clickable, linking directly to that + line, which is highlighted on arrival. Added a link back to the index page + at the bottom of each HTML page. + +- 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.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 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`_. + +- Source files with DOS line endings are now properly tokenized for syntax + coloring on non-DOS machines. Fixes `issue 53`_. + +- Unusual code structure that confused exits from methods with exits from + classes is now properly analyzed. See `issue 62`_. + +- Asking for an HTML report with no files now shows a nice error message rather + than a cryptic failure ('int' object is unsubscriptable). Fixes `issue 59`_. + +.. _issue 1: https://github.com/nedbat/coveragepy/issues/1 +.. _issue 34: https://github.com/nedbat/coveragepy/issues/34 +.. _issue 36: https://github.com/nedbat/coveragepy/issues/36 +.. _issue 46: https://github.com/nedbat/coveragepy/issues/46 +.. _issue 53: https://github.com/nedbat/coveragepy/issues/53 +.. _issue 52: https://github.com/nedbat/coveragepy/issues/52 +.. _issue 56: https://github.com/nedbat/coveragepy/issues/56 +.. _issue 61: https://github.com/nedbat/coveragepy/issues/61 +.. _issue 62: https://github.com/nedbat/coveragepy/issues/62 +.. _issue 59: https://github.com/nedbat/coveragepy/issues/59 +.. _issue 82: https://github.com/nedbat/coveragepy/issues/82 + + +.. _changes_331: + +Version 3.3.1 --- 2010-03-06 +---------------------------- + +- Using `parallel=True` in .coveragerc file prevented reporting, but now does + not, fixing `issue 49`_. + +- When running your code with "coverage run", if you call `sys.exit()`, + coverage.py will exit with that status code, fixing `issue 50`_. + +.. _issue 49: https://github.com/nedbat/coveragepy/issues/49 +.. _issue 50: https://github.com/nedbat/coveragepy/issues/50 + + +.. _changes_33: + +Version 3.3 --- 2010-02-24 +-------------------------- + +- Settings are now read from a .coveragerc file. A specific file can be + specified on the command line with --rcfile=FILE. The name of the file can + be programmatically set with the `config_file` argument to the coverage() + constructor, or reading a config file can be disabled with + `config_file=False`. + +- Fixed a problem with nested loops having their branch possibilities + mischaracterized: `issue 39`_. + +- Added coverage.process_start to enable coverage measurement when Python + starts. + +- Parallel data file names now have a random number appended to them in + addition to the machine name and process id. + +- Parallel data files combined with "coverage combine" are deleted after + they're combined, to clean up unneeded files. Fixes `issue 40`_. + +- Exceptions thrown from product code run with "coverage run" are now displayed + without internal coverage.py frames, so the output is the same as when the + code is run without coverage.py. + +- The `data_suffix` argument to the coverage constructor is now appended with + an added dot rather than simply appended, so that .coveragerc files will not + be confused for data files. + +- Python source files that don't end with a newline can now be executed, fixing + `issue 47`_. + +- Added an AUTHORS.txt file. + +.. _issue 39: https://github.com/nedbat/coveragepy/issues/39 +.. _issue 40: https://github.com/nedbat/coveragepy/issues/40 +.. _issue 47: https://github.com/nedbat/coveragepy/issues/47 + + +.. _changes_32: + +Version 3.2 --- 2009-12-05 +-------------------------- + +- Added a ``--version`` option on the command line. + + +Version 3.2b4 --- 2009-12-01 +---------------------------- + +- Branch coverage improvements: + + - The XML report now includes branch information. + +- Click-to-sort HTML report columns are now persisted in a cookie. Viewing + a report will sort it first the way you last had a coverage report sorted. + Thanks, `Chris Adams`_. + +- On Python 3.x, setuptools has been replaced by `Distribute`_. + +.. _Distribute: https://pypi.org/project/distribute/ + + +Version 3.2b3 --- 2009-11-23 +---------------------------- + +- Fixed a memory leak in the C tracer that was introduced in 3.2b1. + +- Branch coverage improvements: + + - Branches to excluded code are ignored. + +- The table of contents in the HTML report is now sortable: click the headers + on any column. Thanks, `Chris Adams`_. + +.. _Chris Adams: http://chris.improbable.org + + +Version 3.2b2 --- 2009-11-19 +---------------------------- + +- Branch coverage improvements: + + - Classes are no longer incorrectly marked as branches: `issue 32`_. + + - "except" clauses with types are no longer incorrectly marked as branches: + `issue 35`_. + +- Fixed some problems syntax coloring sources with line continuations and + source with tabs: `issue 30`_ and `issue 31`_. + +- The --omit option now works much better than before, fixing `issue 14`_ and + `issue 33`_. Thanks, Danek Duvall. + +.. _issue 14: https://github.com/nedbat/coveragepy/issues/14 +.. _issue 30: https://github.com/nedbat/coveragepy/issues/30 +.. _issue 31: https://github.com/nedbat/coveragepy/issues/31 +.. _issue 32: https://github.com/nedbat/coveragepy/issues/32 +.. _issue 33: https://github.com/nedbat/coveragepy/issues/33 +.. _issue 35: https://github.com/nedbat/coveragepy/issues/35 + + +Version 3.2b1 --- 2009-11-10 +---------------------------- + +- Branch coverage! + +- XML reporting has file paths that let Cobertura find the source code. + +- The tracer code has changed, it's a few percent faster. + +- Some exceptions reported by the command line interface have been cleaned up + so that tracebacks inside coverage.py aren't shown. Fixes `issue 23`_. + +.. _issue 23: https://github.com/nedbat/coveragepy/issues/23 + + +.. _changes_31: + +Version 3.1 --- 2009-10-04 +-------------------------- + +- Source code can now be read from eggs. Thanks, Ross Lawley. Fixes + `issue 25`_. + +.. _issue 25: https://github.com/nedbat/coveragepy/issues/25 + + +Version 3.1b1 --- 2009-09-27 +---------------------------- + +- Python 3.1 is now supported. + +- Coverage.py has a new command line syntax with sub-commands. This expands + the possibilities for adding features and options in the future. The old + syntax is still supported. Try "coverage help" to see the new commands. + Thanks to Ben Finney for early help. + +- Added an experimental "coverage xml" command for producing coverage reports + in a Cobertura-compatible XML format. Thanks, Bill Hart. + +- Added the --timid option to enable a simpler slower trace function that works + for DecoratorTools projects, including TurboGears. Fixed `issue 12`_ and + `issue 13`_. + +- HTML reports show modules from other directories. Fixed `issue 11`_. + +- HTML reports now display syntax-colored Python source. + +- Programs that change directory will still write .coverage files in the + directory where execution started. Fixed `issue 24`_. + +- Added a "coverage debug" command for getting diagnostic information about the + coverage.py installation. + +.. _issue 11: https://github.com/nedbat/coveragepy/issues/11 +.. _issue 12: https://github.com/nedbat/coveragepy/issues/12 +.. _issue 13: https://github.com/nedbat/coveragepy/issues/13 +.. _issue 24: https://github.com/nedbat/coveragepy/issues/24 + + +.. _changes_301: + +Version 3.0.1 --- 2009-07-07 +---------------------------- + +- Removed the recursion limit in the tracer function. Previously, code that + ran more than 500 frames deep would crash. Fixed `issue 9`_. + +- Fixed a bizarre problem involving pyexpat, whereby lines following XML parser + invocations could be overlooked. Fixed `issue 10`_. + +- 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.py modules will be mentioned in the nose --with-cover plug-in. + 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. + +.. _issue 9: https://github.com/nedbat/coveragepy/issues/9 +.. _issue 10: https://github.com/nedbat/coveragepy/issues/10 +.. _issue 8: https://github.com/nedbat/coveragepy/issues/8 + + +.. _changes_30: + +Version 3.0 --- 2009-06-13 +-------------------------- + +- Fixed the way the Python library was ignored. Too much code was being + excluded the old way. + +- Tabs are now properly converted in HTML reports. Previously indentation was + lost. Fixed `issue 6`_. + +- Nested modules now get a proper flat_rootname. Thanks, Christian Heimes. + +.. _issue 6: https://github.com/nedbat/coveragepy/issues/6 + + +Version 3.0b3 --- 2009-05-16 +---------------------------- + +- Added parameters to coverage.__init__ for options that had been set on the + coverage object itself. + +- Added clear_exclude() and get_exclude_list() methods for programmatic + manipulation of the exclude regexes. + +- Added coverage.load() to read previously-saved data from the data file. + +- Improved the finding of code files. For example, .pyc files that have been + installed after compiling are now located correctly. Thanks, Detlev + Offenbach. + +- When using the object API (that is, constructing a coverage() object), data + is no longer saved automatically on process exit. You can re-enable it with + the auto_data=True parameter on the coverage() constructor. The module-level + interface still uses automatic saving. + + +Version 3.0b --- 2009-04-30 +--------------------------- + +HTML reporting, and continued refactoring. + +- HTML reports and annotation of source files: use the new -b (browser) switch. + Thanks to George Song for code, inspiration and guidance. + +- Code in the Python standard library is not measured by default. If you need + to measure standard library code, use the -L command-line switch during + execution, or the cover_pylib=True argument to the coverage() constructor. + +- Source annotation into a directory (-a -d) behaves differently. The + annotated files are named with their hierarchy flattened so that same-named + files from different directories no longer collide. Also, only files in the + current tree are included. + +- coverage.annotate_file is no longer available. + +- Programs executed with -x now behave more as they should, for example, + __file__ has the correct value. + +- .coverage data files have a new pickle-based format designed for better + extensibility. + +- Removed the undocumented cache_file argument to coverage.usecache(). + + +Version 3.0b1 --- 2009-03-07 +---------------------------- + +Major overhaul. + +- Coverage.py is now a package rather than a module. Functionality has been + split into classes. + +- 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.py. + +- The minimum supported Python version is 2.3. + + +Version 2.85 --- 2008-09-14 +--------------------------- + +- Add support for finding source files in eggs. Don't check for + morf's being instances of ModuleType, instead use duck typing so that + pseudo-modules can participate. Thanks, Imri Goldberg. + +- Use os.realpath as part of the fixing of file names so that symlinks won't + confuse things. Thanks, Patrick Mezard. + + +Version 2.80 --- 2008-05-25 +--------------------------- + +- Open files in rU mode to avoid line ending craziness. Thanks, Edward Loper. + + +Version 2.78 --- 2007-09-30 +--------------------------- + +- Don't try to predict whether a file is Python source based on the extension. + Extension-less files are often Pythons scripts. Instead, simply parse the + file and catch the syntax errors. Hat tip to Ben Finney. + + +Version 2.77 --- 2007-07-29 +--------------------------- + +- Better packaging. + + +Version 2.76 --- 2007-07-23 +--------------------------- + +- Now Python 2.5 is *really* fully supported: the body of the new with + statement is counted as executable. + + +Version 2.75 --- 2007-07-22 +--------------------------- + +- Python 2.5 now fully supported. The method of dealing with multi-line + statements is now less sensitive to the exact line that Python reports during + execution. Pass statements are handled specially so that their disappearance + during execution won't throw off the measurement. + + +Version 2.7 --- 2007-07-21 +-------------------------- + +- "#pragma: nocover" is excluded by default. + +- Properly ignore docstrings and other constant expressions that appear in the + middle of a function, a problem reported by Tim Leslie. + +- coverage.erase() shouldn't clobber the exclude regex. Change how parallel + mode is invoked, and fix erase() so that it erases the cache when called + programmatically. + +- In reports, ignore code executed from strings, since we can't do anything + useful with it anyway. + +- Better file handling on Linux, thanks Guillaume Chazarain. + +- Better shell support on Windows, thanks Noel O'Boyle. + +- Python 2.2 support maintained, thanks Catherine Proulx. + +- Minor changes to avoid lint warnings. + + +Version 2.6 --- 2006-08-23 +-------------------------- + +- Applied Joseph Tate's patch for function decorators. + +- Applied Sigve Tjora and Mark van der Wal's fixes for argument handling. + +- Applied Geoff Bache's parallel mode patch. + +- Refactorings to improve testability. Fixes to command-line logic for parallel + mode and collect. + + +Version 2.5 --- 2005-12-04 +-------------------------- + +- Call threading.settrace so that all threads are measured. Thanks Martin + Fuzzey. + +- Add a file argument to report so that reports can be captured to a different + destination. + +- Coverage.py can now measure itself. + +- Adapted Greg Rogers' patch for using relative file names, and sorting and + omitting files to report on. + + +Version 2.2 --- 2004-12-31 +-------------------------- + +- Allow for keyword arguments in the module global functions. Thanks, Allen. + + +Version 2.1 --- 2004-12-14 +-------------------------- + +- Return 'analysis' to its original behavior and add 'analysis2'. Add a global + for 'annotate', and factor it, adding 'annotate_file'. + + +Version 2.0 --- 2004-12-12 +-------------------------- + +Significant code changes. + +- Finding executable statements has been rewritten so that docstrings and + other quirks of Python execution aren't mistakenly identified as missing + lines. + +- Lines can be excluded from consideration, even entire suites of lines. + +- The file system cache of covered lines can be disabled programmatically. + +- Modernized the code. + + +Earlier History +--------------- + +2001-12-04 GDR Created. + +2001-12-06 GDR Added command-line interface and source code annotation. + +2001-12-09 GDR Moved design and interface to separate documents. + +2001-12-10 GDR Open cache file as binary on Windows. Allow simultaneous -e and +-x, or -a and -r. + +2001-12-12 GDR Added command-line help. Cache analysis so that it only needs to +be done once when you specify -a and -r. + +2001-12-13 GDR Improved speed while recording. Portable between Python 1.5.2 +and 2.1.1. + +2002-01-03 GDR Module-level functions work correctly. + +2002-01-07 GDR Update sys.path when running a file with the -x option, so that +it matches the value the program would get if it were run on its own. + From 73ca4596fc8eed9c76714e7a5c80dd61d71fe1b1 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 11 Oct 2021 21:47:36 -0400 Subject: [PATCH 003/137] docs: use real emdashes for better rendering --- CHANGES.rst | 40 ++--- doc/changes.rst | 417 +++++++++++++++++++++--------------------------- 2 files changed, 206 insertions(+), 251 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 20aab53d9..e45c54ac2 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -16,8 +16,8 @@ This list is detailed and covers changes in each pre-release version. .. .. .. _changes_981: .. - .. Version 9.8.1 --- 2027-07-27 - .. ---------------------------- + .. Version 9.8.1 — 2027-07-27 + .. -------------------------- Unreleased @@ -28,8 +28,8 @@ Nothing yet. .. _changes_602: -Version 6.0.2 --- 2021-10-11 ----------------------------- +Version 6.0.2 — 2021-10-11 +-------------------------- - Namespace packages being measured weren't properly handled by the new code that ignores third-party packages. If the namespace package was installed, it @@ -54,8 +54,8 @@ Version 6.0.2 --- 2021-10-11 .. _changes_601: -Version 6.0.1 --- 2021-10-06 ----------------------------- +Version 6.0.1 — 2021-10-06 +-------------------------- - In 6.0, the coverage.py exceptions moved from coverage.misc to coverage.exceptions. These exceptions are not part of the public supported @@ -77,8 +77,8 @@ Version 6.0.1 --- 2021-10-06 .. _changes_60: -Version 6.0 --- 2021-10-03 --------------------------- +Version 6.0 — 2021-10-03 +------------------------ - The ``coverage html`` command now prints a message indicating where the HTML report was written. Fixes `issue 1195`_. @@ -114,8 +114,8 @@ Version 6.0 --- 2021-10-03 .. _changes_60b1: -Version 6.0b1 --- 2021-07-18 ----------------------------- +Version 6.0b1 — 2021-07-18 +-------------------------- - Dropped support for Python 2.7, PyPy 2, and Python 3.5. @@ -164,8 +164,8 @@ Version 6.0b1 --- 2021-07-18 .. _changes_56b1: -Version 5.6b1 --- 2021-04-13 ----------------------------- +Version 5.6b1 — 2021-04-13 +-------------------------- Note: 5.6 final was never released. These changes are part of 6.0. @@ -193,8 +193,8 @@ Note: 5.6 final was never released. These changes are part of 6.0. .. _changes_55: -Version 5.5 --- 2021-02-28 --------------------------- +Version 5.5 — 2021-02-28 +------------------------ - ``coverage combine`` has a new option, ``--keep`` to keep the original data files after combining them. The default is still to delete the files after @@ -229,8 +229,8 @@ Version 5.5 --- 2021-02-28 .. _changes_54: -Version 5.4 --- 2021-01-24 --------------------------- +Version 5.4 — 2021-01-24 +------------------------ - The text report produced by ``coverage report`` now always outputs a TOTAL line, even if only one Python file is reported. This makes regex parsing @@ -264,8 +264,8 @@ Version 5.4 --- 2021-01-24 .. _changes_531: -Version 5.3.1 --- 2020-12-19 ----------------------------- +Version 5.3.1 — 2020-12-19 +-------------------------- - When using ``--source`` on a large source tree, v5.x was slower than previous versions. This performance regression is now fixed, closing `issue 1037`_. @@ -290,8 +290,8 @@ Version 5.3.1 --- 2020-12-19 .. _changes_53: -Version 5.3 --- 2020-09-13 --------------------------- +Version 5.3 — 2020-09-13 +------------------------ - The ``source`` setting has always been interpreted as either a file path or a module, depending on which existed. If both interpretations were valid, it diff --git a/doc/changes.rst b/doc/changes.rst index 6d7bd6587..80b75da79 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -10,55 +10,10 @@ .. Older changes here: -.. _changes_531: - -Version 5.3.1 --- 2020-12-19 ----------------------------- - -- When using ``--source`` on a large source tree, v5.x was slower than previous - versions. This performance regression is now fixed, closing `issue 1037`_. - -- Mysterious SQLite errors can happen on PyPy, as reported in `issue 1010`_. An - immediate retry seems to fix the problem, although it is an unsatisfying - solution. - -- The HTML report now saves the sort order in a more widely supported way, - fixing `issue 986`_. Thanks, Sebastián Ramírez (`pull request 1066`_). - -- The HTML report pages now have a :ref:`Sleepy Snake ` favicon. - -- Wheels are now provided for manylinux2010, and for PyPy3 (pp36 and pp37). - -- Continuous integration has moved from Travis and AppVeyor to GitHub Actions. - -.. _issue 986: https://github.com/nedbat/coveragepy/issues/986 -.. _issue 1037: https://github.com/nedbat/coveragepy/issues/1037 -.. _issue 1010: https://github.com/nedbat/coveragepy/issues/1010 -.. _pull request 1066: https://github.com/nedbat/coveragepy/pull/1066 - -.. _changes_53: - -Version 5.3 --- 2020-09-13 --------------------------- - -- The ``source`` setting has always been interpreted as either a file path or a - module, depending on which existed. If both interpretations were valid, it - was assumed to be a file path. The new ``source_pkgs`` setting can be used - to name a package to disambiguate this case. Thanks, Thomas Grainger. Fixes - `issue 268`_. - -- If a plugin was disabled due to an exception, we used to still try to record - its information, causing an exception, as reported in `issue 1011`_. This is - now fixed. - -.. _issue 268: https://github.com/nedbat/coveragepy/issues/268 -.. _issue 1011: https://github.com/nedbat/coveragepy/issues/1011 - - .. _changes_521: -Version 5.2.1 --- 2020-07-23 ----------------------------- +Version 5.2.1 — 2020-07-23 +-------------------------- - The dark mode HTML report still used light colors for the context listing, making them unreadable (`issue 1009`_). This is now fixed. @@ -72,8 +27,8 @@ Version 5.2.1 --- 2020-07-23 .. _changes_52: -Version 5.2 --- 2020-07-05 --------------------------- +Version 5.2 — 2020-07-05 +------------------------ - The HTML report has been redesigned by Vince Salvino. There is now a dark mode, the code text is larger, and system sans serif fonts are used, in @@ -117,8 +72,8 @@ Version 5.2 --- 2020-07-05 .. _changes_51: -Version 5.1 --- 2020-04-12 --------------------------- +Version 5.1 — 2020-04-12 +------------------------ - The JSON report now includes counts of covered and missing branches. Thanks, Salvatore Zagaria. @@ -138,8 +93,8 @@ Version 5.1 --- 2020-04-12 .. _changes_504: -Version 5.0.4 --- 2020-03-16 ----------------------------- +Version 5.0.4 — 2020-03-16 +-------------------------- - If using the ``[run] relative_files`` setting, the XML report will use relative files in the ```` elements indicating the location of source @@ -166,8 +121,8 @@ Version 5.0.4 --- 2020-03-16 .. _changes_503: -Version 5.0.3 --- 2020-01-12 ----------------------------- +Version 5.0.3 — 2020-01-12 +-------------------------- - A performance improvement in 5.0.2 didn't work for test suites that changed directory before combining data, causing "Couldn't use data file: no such @@ -191,8 +146,8 @@ Version 5.0.3 --- 2020-01-12 .. _changes_502: -Version 5.0.2 --- 2020-01-05 ----------------------------- +Version 5.0.2 — 2020-01-05 +-------------------------- - Programs that used multiprocessing and changed directories would fail under coverage. This is now fixed (`issue 890`_). A side effect is that debug @@ -228,8 +183,8 @@ Version 5.0.2 --- 2020-01-05 .. _changes_501: -Version 5.0.1 --- 2019-12-22 ----------------------------- +Version 5.0.1 — 2019-12-22 +-------------------------- - If a 4.x data file is the cause of a "file is not a database" error, then use a more specific error message, "Looks like a coverage 4.x data file, are you @@ -259,8 +214,8 @@ Version 5.0.1 --- 2019-12-22 .. _changes_50: -Version 5.0 --- 2019-12-14 --------------------------- +Version 5.0 — 2019-12-14 +------------------------ Nothing new beyond 5.0b2. @@ -270,8 +225,8 @@ A summary of major changes in 5.0 since 4.5.x is in see :ref:`whatsnew5x`. .. _changes_50b2: -Version 5.0b2 --- 2019-12-08 ----------------------------- +Version 5.0b2 — 2019-12-08 +-------------------------- - An experimental ``[run] relative_files`` setting tells coverage to store relative file names in the data file. This makes it easier to run tests in @@ -307,8 +262,8 @@ Version 5.0b2 --- 2019-12-08 .. _changes_50b1: -Version 5.0b1 --- 2019-11-11 ----------------------------- +Version 5.0b1 — 2019-11-11 +-------------------------- - The HTML and textual reports now have a ``--skip-empty`` option that skips files with no statements, notably ``__init__.py`` files. Thanks, Reya B. @@ -341,8 +296,8 @@ Version 5.0b1 --- 2019-11-11 .. _changes_50a8: -Version 5.0a8 --- 2019-10-02 ----------------------------- +Version 5.0a8 — 2019-10-02 +-------------------------- - The :class:`.CoverageData` API has changed how queries are limited to specific contexts. Now you use :meth:`.CoverageData.set_query_context` to @@ -354,8 +309,8 @@ Version 5.0a8 --- 2019-10-02 .. _changes_50a7: -Version 5.0a7 --- 2019-09-21 ----------------------------- +Version 5.0a7 — 2019-09-21 +-------------------------- - Data can now be "reported" in JSON format, for programmatic use, as requested in `issue 720`_. The new ``coverage json`` command writes raw and summarized @@ -390,8 +345,8 @@ Version 5.0a7 --- 2019-09-21 .. _changes_50a6: -Version 5.0a6 --- 2019-07-16 ----------------------------- +Version 5.0a6 — 2019-07-16 +-------------------------- - Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas for the contribution. @@ -458,8 +413,8 @@ Version 5.0a6 --- 2019-07-16 .. _changes_50a5: -Version 5.0a5 --- 2019-05-07 ----------------------------- +Version 5.0a5 — 2019-05-07 +-------------------------- - Drop support for Python 3.4 @@ -509,8 +464,8 @@ Version 5.0a5 --- 2019-05-07 .. _changes_50a4: -Version 5.0a4 --- 2018-11-25 ----------------------------- +Version 5.0a4 — 2018-11-25 +-------------------------- - You can specify the command line to run your program with the ``[run] command_line`` configuration setting, as requested in `issue 695`_. @@ -539,8 +494,8 @@ Version 5.0a4 --- 2018-11-25 .. _changes_50a3: -Version 5.0a3 --- 2018-10-06 ----------------------------- +Version 5.0a3 — 2018-10-06 +-------------------------- - Context support: static contexts let you specify a label for a coverage run, which is recorded in the data, and retained when you combine files. See @@ -580,8 +535,8 @@ Version 5.0a3 --- 2018-10-06 .. _changes_50a2: -Version 5.0a2 --- 2018-09-03 ----------------------------- +Version 5.0a2 — 2018-09-03 +-------------------------- - Coverage's data storage has changed. In version 4.x, .coverage files were basically JSON. Now, they are SQLite databases. This means the data file @@ -616,8 +571,8 @@ Version 5.0a2 --- 2018-09-03 .. _changes_50a1: -Version 5.0a1 --- 2018-06-05 ----------------------------- +Version 5.0a1 — 2018-06-05 +-------------------------- - Coverage.py no longer supports Python 2.6 or 3.3. @@ -643,8 +598,8 @@ Version 5.0a1 --- 2018-06-05 .. _changes_454: -Version 4.5.4 --- 2019-07-29 ----------------------------- +Version 4.5.4 — 2019-07-29 +-------------------------- - Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes `issue 828`_. @@ -654,16 +609,16 @@ Version 4.5.4 --- 2019-07-29 .. _changes_453: -Version 4.5.3 --- 2019-03-09 ----------------------------- +Version 4.5.3 — 2019-03-09 +-------------------------- - Only packaging metadata changes. .. _changes_452: -Version 4.5.2 --- 2018-11-12 ----------------------------- +Version 4.5.2 — 2018-11-12 +-------------------------- - Namespace packages are supported on Python 3.7, where they used to cause TypeErrors about path being None. Fixes `issue 700`_. @@ -683,8 +638,8 @@ Version 4.5.2 --- 2018-11-12 .. _changes_451: -Version 4.5.1 --- 2018-02-10 ----------------------------- +Version 4.5.1 — 2018-02-10 +-------------------------- - Now that 4.5 properly separated the ``[run] omit`` and ``[report] omit`` settings, an old bug has become apparent. If you specified a package name @@ -703,8 +658,8 @@ Version 4.5.1 --- 2018-02-10 .. _changes_45: -Version 4.5 --- 2018-02-03 --------------------------- +Version 4.5 — 2018-02-03 +------------------------ - A new kind of plugin is supported: configurers are invoked at start-up to allow more complex configuration than the .coveragerc file can easily do. @@ -748,8 +703,8 @@ Version 4.5 --- 2018-02-03 .. _changes_442: -Version 4.4.2 --- 2017-11-05 ----------------------------- +Version 4.4.2 — 2017-11-05 +-------------------------- - Support for Python 3.7. In some cases, class and module docstrings are no longer counted in statement totals, which could slightly change your total @@ -784,16 +739,16 @@ Version 4.4.2 --- 2017-11-05 .. _changes_441: -Version 4.4.1 --- 2017-05-14 ----------------------------- +Version 4.4.1 — 2017-05-14 +-------------------------- - No code changes: just corrected packaging for Python 2.7 Linux wheels. .. _changes_44: -Version 4.4 --- 2017-05-07 --------------------------- +Version 4.4 — 2017-05-07 +------------------------ - 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 @@ -821,8 +776,8 @@ Version 4.4 --- 2017-05-07 .. _issue 575: https://github.com/nedbat/coveragepy/issues/575 -Version 4.4b1 --- 2017-04-04 ----------------------------- +Version 4.4b1 — 2017-04-04 +-------------------------- - Some warnings can now be individually disabled. Warnings that can be disabled have a short name appended. The ``[run] disable_warnings`` setting @@ -859,8 +814,8 @@ Version 4.4b1 --- 2017-04-04 .. _changes_434: -Version 4.3.4 --- 2017-01-17 ----------------------------- +Version 4.3.4 — 2017-01-17 +-------------------------- - 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`_. @@ -871,8 +826,8 @@ Version 4.3.4 --- 2017-01-17 .. _changes_433: -Version 4.3.3 --- 2017-01-17 ----------------------------- +Version 4.3.3 — 2017-01-17 +-------------------------- - 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 @@ -883,8 +838,8 @@ Version 4.3.3 --- 2017-01-17 .. _changes_432: -Version 4.3.2 --- 2017-01-16 ----------------------------- +Version 4.3.2 — 2017-01-16 +-------------------------- - 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 @@ -930,8 +885,8 @@ Version 4.3.2 --- 2017-01-16 .. _changes_431: -Version 4.3.1 --- 2016-12-28 ----------------------------- +Version 4.3.1 — 2016-12-28 +-------------------------- - Some environments couldn't install 4.3, as described in `issue 540`_. This is now fixed. @@ -947,8 +902,8 @@ Version 4.3.1 --- 2016-12-28 .. _changes_43: -Version 4.3 --- 2016-12-27 --------------------------- +Version 4.3 — 2016-12-27 +------------------------ Special thanks to **Loïc Dachary**, who took an extraordinary interest in coverage.py and contributed a number of improvements in this release. @@ -1076,8 +1031,8 @@ coverage.py and contributed a number of improvements in this release. .. _changes_42: -Version 4.2 --- 2016-07-26 --------------------------- +Version 4.2 — 2016-07-26 +------------------------ - Since ``concurrency=multiprocessing`` uses subprocesses, options specified on the coverage.py command line will not be communicated down to them. Only @@ -1092,8 +1047,8 @@ Version 4.2 --- 2016-07-26 .. _issue 495: https://github.com/nedbat/coveragepy/issues/495 -Version 4.2b1 --- 2016-07-04 ----------------------------- +Version 4.2b1 — 2016-07-04 +-------------------------- Work from the PyCon 2016 Sprints! @@ -1155,16 +1110,16 @@ Work from the PyCon 2016 Sprints! .. _changes_41: -Version 4.1 --- 2016-05-21 --------------------------- +Version 4.1 — 2016-05-21 +------------------------ - 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. -Version 4.1b3 --- 2016-05-10 ----------------------------- +Version 4.1b3 — 2016-05-10 +-------------------------- - 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 @@ -1229,8 +1184,8 @@ Version 4.1b3 --- 2016-05-10 .. _issue 485: https://github.com/nedbat/coveragepy/issues/485 -Version 4.1b2 --- 2016-01-23 ----------------------------- +Version 4.1b2 — 2016-01-23 +-------------------------- - Problems with the new branch measurement in 4.1 beta 1 were fixed: @@ -1253,8 +1208,8 @@ Version 4.1b2 --- 2016-01-23 .. _issue 466: https://github.com/nedbat/coveragepy/issues/466 -Version 4.1b1 --- 2016-01-10 ----------------------------- +Version 4.1b1 — 2016-01-10 +-------------------------- - Branch analysis has been rewritten: it used to be based on bytecode, but now uses AST analysis. This has changed a number of things: @@ -1311,8 +1266,8 @@ Version 4.1b1 --- 2016-01-10 .. _changes_403: -Version 4.0.3 --- 2015-11-24 ----------------------------- +Version 4.0.3 — 2015-11-24 +-------------------------- - Fixed a mysterious problem that manifested in different ways: sometimes hanging the process (`issue 420`_), sometimes making database connections @@ -1338,8 +1293,8 @@ Version 4.0.3 --- 2015-11-24 .. _changes_402: -Version 4.0.2 --- 2015-11-04 ----------------------------- +Version 4.0.2 — 2015-11-04 +-------------------------- - More work on supporting unusually encoded source. Fixed `issue 431`_. @@ -1359,8 +1314,8 @@ Version 4.0.2 --- 2015-11-04 .. _changes_401: -Version 4.0.1 --- 2015-10-13 ----------------------------- +Version 4.0.1 — 2015-10-13 +-------------------------- - When combining data files, unreadable files will now generate a warning instead of failing the command. This is more in line with the older @@ -1407,14 +1362,14 @@ Version 4.0.1 --- 2015-10-13 .. _changes_40: -Version 4.0 --- 2015-09-20 --------------------------- +Version 4.0 — 2015-09-20 +------------------------ No changes from 4.0b3 -Version 4.0b3 --- 2015-09-07 ----------------------------- +Version 4.0b3 — 2015-09-07 +-------------------------- - Reporting on an unmeasured file would fail with a traceback. This is now fixed, closing `issue 403`_. @@ -1433,8 +1388,8 @@ Version 4.0b3 --- 2015-09-07 .. _issue 404: https://github.com/nedbat/coveragepy/issues/404 -Version 4.0b2 --- 2015-08-22 ----------------------------- +Version 4.0b2 — 2015-08-22 +-------------------------- - 4.0b1 broke ``--append`` creating new data files. This is now fixed, closing `issue 392`_. @@ -1466,8 +1421,8 @@ Version 4.0b2 --- 2015-08-22 .. _sys.version_info: https://docs.python.org/3/library/sys.html#sys.version_info -Version 4.0b1 --- 2015-08-02 ----------------------------- +Version 4.0b1 — 2015-08-02 +-------------------------- - Coverage.py is now licensed under the Apache 2.0 license. See NOTICE.txt for details. Closes `issue 313`_. @@ -1545,8 +1500,8 @@ Version 4.0b1 --- 2015-08-02 .. 40 issues closed in 4.0 below here -Version 4.0a6 --- 2015-06-21 ----------------------------- +Version 4.0a6 — 2015-06-21 +-------------------------- - Python 3.5b2 and PyPy 2.6.0 are supported. @@ -1607,8 +1562,8 @@ Version 4.0a6 --- 2015-06-21 .. _issue 375: https://github.com/nedbat/coveragepy/issues/375 -Version 4.0a5 --- 2015-02-16 ----------------------------- +Version 4.0a5 — 2015-02-16 +-------------------------- - Plugin support is now implemented in the C tracer instead of the Python tracer. This greatly improves the speed of tracing projects using plugins. @@ -1641,8 +1596,8 @@ Version 4.0a5 --- 2015-02-16 .. _issue 358: https://github.com/nedbat/coveragepy/issues/358 -Version 4.0a4 --- 2015-01-25 ----------------------------- +Version 4.0a4 — 2015-01-25 +-------------------------- - Plugins can now provide sys_info for debugging output. @@ -1651,8 +1606,8 @@ Version 4.0a4 --- 2015-01-25 - Prepared to move the docs to readthedocs.org. -Version 4.0a3 --- 2015-01-20 ----------------------------- +Version 4.0a3 — 2015-01-20 +-------------------------- - 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 @@ -1685,8 +1640,8 @@ Version 4.0a3 --- 2015-01-20 .. _issue 349: https://github.com/nedbat/coveragepy/issues/349 -Version 4.0a2 --- 2015-01-14 ----------------------------- +Version 4.0a2 — 2015-01-14 +-------------------------- - 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. @@ -1753,8 +1708,8 @@ Version 4.0a2 --- 2015-01-14 .. _issue 343: https://github.com/nedbat/coveragepy/issues/343 -Version 4.0a1 --- 2014-09-27 ----------------------------- +Version 4.0a1 — 2014-09-27 +-------------------------- - Python versions supported are now CPython 2.6, 2.7, 3.2, 3.3, and 3.4, and PyPy 2.2. @@ -1809,8 +1764,8 @@ Version 4.0a1 --- 2014-09-27 .. _changes_371: -Version 3.7.1 --- 2013-12-13 ----------------------------- +Version 3.7.1 — 2013-12-13 +-------------------------- - Improved the speed of HTML report generation by about 20%. @@ -1820,8 +1775,8 @@ Version 3.7.1 --- 2013-12-13 .. _changes_37: -Version 3.7 --- 2013-10-06 --------------------------- +Version 3.7 — 2013-10-06 +------------------------ - Added the ``--debug`` switch to ``coverage run``. It accepts a list of options indicating the type of internal activity to log to stderr. @@ -1879,8 +1834,8 @@ Version 3.7 --- 2013-10-06 .. _changes_36: -Version 3.6 --- 2013-01-05 --------------------------- +Version 3.6 — 2013-01-05 +------------------------ - Added a page to the docs about troublesome situations, closing `issue 226`_, and added some info to the TODO file, closing `issue 227`_. @@ -1889,16 +1844,16 @@ Version 3.6 --- 2013-01-05 .. _issue 227: https://github.com/nedbat/coveragepy/issues/227 -Version 3.6b3 --- 2012-12-29 ----------------------------- +Version 3.6b3 — 2012-12-29 +-------------------------- - Beta 2 broke the nose plugin. It's fixed again, closing `issue 224`_. .. _issue 224: https://github.com/nedbat/coveragepy/issues/224 -Version 3.6b2 --- 2012-12-23 ----------------------------- +Version 3.6b2 — 2012-12-23 +-------------------------- - Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1. @@ -1917,8 +1872,8 @@ Version 3.6b2 --- 2012-12-23 .. _issue 221: https://github.com/nedbat/coveragepy/issues/221 -Version 3.6b1 --- 2012-11-28 ----------------------------- +Version 3.6b1 — 2012-11-28 +-------------------------- - Wildcards in ``include=`` and ``omit=`` arguments were not handled properly in reporting functions, though they were when running. Now they are handled @@ -2033,8 +1988,8 @@ Version 3.6b1 --- 2012-11-28 .. _changes_353: -Version 3.5.3 --- 2012-09-29 ----------------------------- +Version 3.5.3 — 2012-09-29 +-------------------------- - Line numbers in the HTML report line up better with the source lines, fixing `issue 197`_, thanks Marius Gedminas. @@ -2074,14 +2029,14 @@ Version 3.5.3 --- 2012-09-29 .. _changes_352: -Version 3.5.2 --- 2012-05-04 ----------------------------- +Version 3.5.2 — 2012-05-04 +-------------------------- No changes since 3.5.2.b1 -Version 3.5.2b1 --- 2012-04-29 ------------------------------- +Version 3.5.2b1 — 2012-04-29 +---------------------------- - The HTML report has slightly tweaked controls: the buttons at the top of the page are color-coded to the source lines they affect. @@ -2126,16 +2081,16 @@ Version 3.5.2b1 --- 2012-04-29 .. _changes_351: -Version 3.5.1 --- 2011-09-23 ----------------------------- +Version 3.5.1 — 2011-09-23 +-------------------------- - The ``[paths]`` feature unfortunately didn't work in real world situations where you wanted to, you know, report on the combined data. Now all paths stored in the combined file are canonicalized properly. -Version 3.5.1b1 --- 2011-08-28 ------------------------------- +Version 3.5.1b1 — 2011-08-28 +---------------------------- - When combining data files from parallel runs, you can now instruct coverage.py about which directories are equivalent on different machines. A @@ -2175,8 +2130,8 @@ Version 3.5.1b1 --- 2011-08-28 .. _changes_35: -Version 3.5 --- 2011-06-29 --------------------------- +Version 3.5 — 2011-06-29 +------------------------ - The HTML report hotkeys now behave slightly differently when the current chunk isn't visible at all: a chunk on the screen will be selected, @@ -2184,8 +2139,8 @@ Version 3.5 --- 2011-06-29 The hotkeys now work in Google Chrome. Thanks, Guido van Rossum. -Version 3.5b1 --- 2011-06-05 ----------------------------- +Version 3.5b1 — 2011-06-05 +-------------------------- - The HTML report now has hotkeys. Try ``n``, ``s``, ``m``, ``x``, ``b``, ``p``, and ``c`` on the overview page to change the column sorting. @@ -2265,8 +2220,8 @@ Version 3.5b1 --- 2011-06-05 .. _changes_34: -Version 3.4 --- 2010-09-19 --------------------------- +Version 3.4 — 2010-09-19 +------------------------ - The XML report is now sorted by package name, fixing `issue 88`_. @@ -2276,8 +2231,8 @@ Version 3.4 --- 2010-09-19 .. _issue 88: https://github.com/nedbat/coveragepy/issues/88 -Version 3.4b2 --- 2010-09-06 ----------------------------- +Version 3.4b2 — 2010-09-06 +-------------------------- - Completely unexecuted files can now be included in coverage results, reported as 0% covered. This only happens if the --source option is specified, since @@ -2306,8 +2261,8 @@ Version 3.4b2 --- 2010-09-06 .. _issue 85: https://github.com/nedbat/coveragepy/issues/85 -Version 3.4b1 --- 2010-08-21 ----------------------------- +Version 3.4b1 — 2010-08-21 +-------------------------- - BACKWARD INCOMPATIBILITY: the ``--omit`` and ``--include`` switches now take file patterns rather than file prefixes, closing `issue 34`_ and `issue 36`_. @@ -2394,8 +2349,8 @@ Version 3.4b1 --- 2010-08-21 .. _changes_331: -Version 3.3.1 --- 2010-03-06 ----------------------------- +Version 3.3.1 — 2010-03-06 +-------------------------- - Using `parallel=True` in .coveragerc file prevented reporting, but now does not, fixing `issue 49`_. @@ -2409,8 +2364,8 @@ Version 3.3.1 --- 2010-03-06 .. _changes_33: -Version 3.3 --- 2010-02-24 --------------------------- +Version 3.3 — 2010-02-24 +------------------------ - Settings are now read from a .coveragerc file. A specific file can be specified on the command line with --rcfile=FILE. The name of the file can @@ -2450,14 +2405,14 @@ Version 3.3 --- 2010-02-24 .. _changes_32: -Version 3.2 --- 2009-12-05 --------------------------- +Version 3.2 — 2009-12-05 +------------------------ - Added a ``--version`` option on the command line. -Version 3.2b4 --- 2009-12-01 ----------------------------- +Version 3.2b4 — 2009-12-01 +-------------------------- - Branch coverage improvements: @@ -2472,8 +2427,8 @@ Version 3.2b4 --- 2009-12-01 .. _Distribute: https://pypi.org/project/distribute/ -Version 3.2b3 --- 2009-11-23 ----------------------------- +Version 3.2b3 — 2009-11-23 +-------------------------- - Fixed a memory leak in the C tracer that was introduced in 3.2b1. @@ -2487,8 +2442,8 @@ Version 3.2b3 --- 2009-11-23 .. _Chris Adams: http://chris.improbable.org -Version 3.2b2 --- 2009-11-19 ----------------------------- +Version 3.2b2 — 2009-11-19 +-------------------------- - Branch coverage improvements: @@ -2511,8 +2466,8 @@ Version 3.2b2 --- 2009-11-19 .. _issue 35: https://github.com/nedbat/coveragepy/issues/35 -Version 3.2b1 --- 2009-11-10 ----------------------------- +Version 3.2b1 — 2009-11-10 +-------------------------- - Branch coverage! @@ -2528,8 +2483,8 @@ Version 3.2b1 --- 2009-11-10 .. _changes_31: -Version 3.1 --- 2009-10-04 --------------------------- +Version 3.1 — 2009-10-04 +------------------------ - Source code can now be read from eggs. Thanks, Ross Lawley. Fixes `issue 25`_. @@ -2537,8 +2492,8 @@ Version 3.1 --- 2009-10-04 .. _issue 25: https://github.com/nedbat/coveragepy/issues/25 -Version 3.1b1 --- 2009-09-27 ----------------------------- +Version 3.1b1 — 2009-09-27 +-------------------------- - Python 3.1 is now supported. @@ -2572,8 +2527,8 @@ Version 3.1b1 --- 2009-09-27 .. _changes_301: -Version 3.0.1 --- 2009-07-07 ----------------------------- +Version 3.0.1 — 2009-07-07 +-------------------------- - Removed the recursion limit in the tracer function. Previously, code that ran more than 500 frames deep would crash. Fixed `issue 9`_. @@ -2599,8 +2554,8 @@ Version 3.0.1 --- 2009-07-07 .. _changes_30: -Version 3.0 --- 2009-06-13 --------------------------- +Version 3.0 — 2009-06-13 +------------------------ - Fixed the way the Python library was ignored. Too much code was being excluded the old way. @@ -2613,8 +2568,8 @@ Version 3.0 --- 2009-06-13 .. _issue 6: https://github.com/nedbat/coveragepy/issues/6 -Version 3.0b3 --- 2009-05-16 ----------------------------- +Version 3.0b3 — 2009-05-16 +-------------------------- - Added parameters to coverage.__init__ for options that had been set on the coverage object itself. @@ -2634,8 +2589,8 @@ Version 3.0b3 --- 2009-05-16 interface still uses automatic saving. -Version 3.0b --- 2009-04-30 ---------------------------- +Version 3.0b — 2009-04-30 +------------------------- HTML reporting, and continued refactoring. @@ -2662,8 +2617,8 @@ HTML reporting, and continued refactoring. - Removed the undocumented cache_file argument to coverage.usecache(). -Version 3.0b1 --- 2009-03-07 ----------------------------- +Version 3.0b1 — 2009-03-07 +-------------------------- Major overhaul. @@ -2687,8 +2642,8 @@ Major overhaul. - The minimum supported Python version is 2.3. -Version 2.85 --- 2008-09-14 ---------------------------- +Version 2.85 — 2008-09-14 +------------------------- - Add support for finding source files in eggs. Don't check for morf's being instances of ModuleType, instead use duck typing so that @@ -2698,35 +2653,35 @@ Version 2.85 --- 2008-09-14 confuse things. Thanks, Patrick Mezard. -Version 2.80 --- 2008-05-25 ---------------------------- +Version 2.80 — 2008-05-25 +------------------------- - Open files in rU mode to avoid line ending craziness. Thanks, Edward Loper. -Version 2.78 --- 2007-09-30 ---------------------------- +Version 2.78 — 2007-09-30 +------------------------- - Don't try to predict whether a file is Python source based on the extension. Extension-less files are often Pythons scripts. Instead, simply parse the file and catch the syntax errors. Hat tip to Ben Finney. -Version 2.77 --- 2007-07-29 ---------------------------- +Version 2.77 — 2007-07-29 +------------------------- - Better packaging. -Version 2.76 --- 2007-07-23 ---------------------------- +Version 2.76 — 2007-07-23 +------------------------- - Now Python 2.5 is *really* fully supported: the body of the new with statement is counted as executable. -Version 2.75 --- 2007-07-22 ---------------------------- +Version 2.75 — 2007-07-22 +------------------------- - Python 2.5 now fully supported. The method of dealing with multi-line statements is now less sensitive to the exact line that Python reports during @@ -2734,8 +2689,8 @@ Version 2.75 --- 2007-07-22 during execution won't throw off the measurement. -Version 2.7 --- 2007-07-21 --------------------------- +Version 2.7 — 2007-07-21 +------------------------ - "#pragma: nocover" is excluded by default. @@ -2758,8 +2713,8 @@ Version 2.7 --- 2007-07-21 - Minor changes to avoid lint warnings. -Version 2.6 --- 2006-08-23 --------------------------- +Version 2.6 — 2006-08-23 +------------------------ - Applied Joseph Tate's patch for function decorators. @@ -2771,8 +2726,8 @@ Version 2.6 --- 2006-08-23 mode and collect. -Version 2.5 --- 2005-12-04 --------------------------- +Version 2.5 — 2005-12-04 +------------------------ - Call threading.settrace so that all threads are measured. Thanks Martin Fuzzey. @@ -2786,21 +2741,21 @@ Version 2.5 --- 2005-12-04 omitting files to report on. -Version 2.2 --- 2004-12-31 --------------------------- +Version 2.2 — 2004-12-31 +------------------------ - Allow for keyword arguments in the module global functions. Thanks, Allen. -Version 2.1 --- 2004-12-14 --------------------------- +Version 2.1 — 2004-12-14 +------------------------ - Return 'analysis' to its original behavior and add 'analysis2'. Add a global for 'annotate', and factor it, adding 'annotate_file'. -Version 2.0 --- 2004-12-12 --------------------------- +Version 2.0 — 2004-12-12 +------------------------ Significant code changes. From ce0e38e131e987c1bba1dd51abb2d4a002ac3c4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20G=C3=B3rny?= Date: Tue, 12 Oct 2021 08:03:14 +0200 Subject: [PATCH 004/137] fix: find_writable_pth_directory must expect failure from open() Fix find_writable_pth_directory() to expect the OSError from the open() call. In general, this is what's going to happen if the file is not writable. The current logic could only be triggered e.g. if the file was writable but the underlying filesystem run out of space. --- tests/test_process.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/test_process.py b/tests/test_process.py index 63dd1d5b6..a31350498 100644 --- a/tests/test_process.py +++ b/tests/test_process.py @@ -1419,11 +1419,11 @@ def find_writable_pth_directory(): """Find a place to write a .pth file.""" for pth_dir in possible_pth_dirs(): # pragma: part covered try_it = os.path.join(pth_dir, f"touch_{WORKER}.it") - with open(try_it, "w") as f: - try: + try: + with open(try_it, "w") as f: f.write("foo") - except OSError: # pragma: cant happen - continue + except OSError: # pragma: cant happen + continue os.remove(try_it) return pth_dir From 5b6b6ecb87f4aa1145977b1a4c8359b202da0d7a Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 12 Oct 2021 07:21:45 -0400 Subject: [PATCH 005/137] test: lightly test the ast_dump function --- coverage/parser.py | 133 +++++++++++++++++++++---------------------- tests/test_parser.py | 26 ++++++++- 2 files changed, 90 insertions(+), 69 deletions(-) diff --git a/coverage/parser.py b/coverage/parser.py index 3be822d55..80665b5ae 100644 --- a/coverage/parser.py +++ b/coverage/parser.py @@ -604,10 +604,6 @@ def __new__(cls, lineno, cause=None): new_contract('ArcStarts', lambda seq: all(isinstance(x, ArcStart) for x in seq)) -# Turn on AST dumps with an environment variable. -# $set_env.py: COVERAGE_AST_DUMP - Dump the AST nodes when parsing code. -AST_DUMP = bool(int(os.environ.get("COVERAGE_AST_DUMP", 0))) - class NodeList: """A synthetic fictitious node, containing a sequence of nodes. @@ -619,22 +615,30 @@ def __init__(self, body): self.body = body self.lineno = body[0].lineno - # TODO: some add_arcs methods here don't add arcs, they return them. Rename them. # TODO: the cause messages have too many commas. # TODO: Shouldn't the cause messages join with "and" instead of "or"? +def ast_parse(text): + """How we create an AST parse.""" + return ast.parse(neuter_encoding_declaration(text)) + + class AstArcAnalyzer: """Analyze source text with an AST to find executable code paths.""" @contract(text='unicode', statements=set) def __init__(self, text, statements, multiline): - self.root_node = ast.parse(neuter_encoding_declaration(text)) + self.root_node = ast_parse(text) # TODO: I think this is happening in too many places. self.statements = {multiline.get(l, l) for l in statements} self.multiline = multiline - if AST_DUMP: # pragma: debugging + # Turn on AST dumps with an environment variable. + # $set_env.py: COVERAGE_AST_DUMP - Dump the AST nodes when parsing code. + dump_ast = bool(int(os.environ.get("COVERAGE_AST_DUMP", 0))) + + if dump_ast: # pragma: debugging # Dump the AST so that failing tests have helpful output. print(f"Statements: {self.statements}") print(f"Multiline map: {self.multiline}") @@ -1294,69 +1298,64 @@ def _code_object__expression_callable(self, node): _code_object__ListComp = _make_expression_code_method("list comprehension") -if AST_DUMP: # pragma: debugging - # Code only used when dumping the AST for debugging. +# Code only used when dumping the AST for debugging. - SKIP_DUMP_FIELDS = ["ctx"] +SKIP_DUMP_FIELDS = ["ctx"] - def _is_simple_value(value): - """Is `value` simple enough to be displayed on a single line?""" - return ( - value in [None, [], (), {}, set()] or - isinstance(value, (str, int, float)) - ) +def _is_simple_value(value): + """Is `value` simple enough to be displayed on a single line?""" + return ( + value in [None, [], (), {}, set()] or + isinstance(value, (str, int, float)) + ) - def ast_dump(node, depth=0): - """Dump the AST for `node`. +def ast_dump(node, depth=0, print=print): # pylint: disable=redefined-builtin + """Dump the AST for `node`. - This recursively walks the AST, printing a readable version. + This recursively walks the AST, printing a readable version. - """ - indent = " " * depth - if not isinstance(node, ast.AST): - print(f"{indent}<{node.__class__.__name__} {node!r}>") - return - - lineno = getattr(node, "lineno", None) - if lineno is not None: - linemark = f" @ {node.lineno},{node.col_offset}" - if hasattr(node, "end_lineno"): - linemark += ":" - if node.end_lineno != node.lineno: - linemark += f"{node.end_lineno}," - linemark += f"{node.end_col_offset}" - else: - linemark = "" - head = f"{indent}<{node.__class__.__name__}{linemark}" - - named_fields = [ - (name, value) - for name, value in ast.iter_fields(node) - if name not in SKIP_DUMP_FIELDS - ] - if not named_fields: - print(f"{head}>") - elif len(named_fields) == 1 and _is_simple_value(named_fields[0][1]): - field_name, value = named_fields[0] - print(f"{head} {field_name}: {value!r}>") - else: - print(head) - if 0: - print("{}# mro: {}".format( - indent, ", ".join(c.__name__ for c in node.__class__.__mro__[1:]), - )) - next_indent = indent + " " - for field_name, value in named_fields: - prefix = f"{next_indent}{field_name}:" - if _is_simple_value(value): - print(f"{prefix} {value!r}") - elif isinstance(value, list): - print(f"{prefix} [") - for n in value: - ast_dump(n, depth + 8) - print(f"{next_indent}]") - else: - print(prefix) - ast_dump(value, depth + 8) + """ + indent = " " * depth + lineno = getattr(node, "lineno", None) + if lineno is not None: + linemark = f" @ {node.lineno},{node.col_offset}" + if hasattr(node, "end_lineno"): + linemark += ":" + if node.end_lineno != node.lineno: + linemark += f"{node.end_lineno}," + linemark += f"{node.end_col_offset}" + else: + linemark = "" + head = f"{indent}<{node.__class__.__name__}{linemark}" + + named_fields = [ + (name, value) + for name, value in ast.iter_fields(node) + if name not in SKIP_DUMP_FIELDS + ] + if not named_fields: + print(f"{head}>") + elif len(named_fields) == 1 and _is_simple_value(named_fields[0][1]): + field_name, value = named_fields[0] + print(f"{head} {field_name}: {value!r}>") + else: + print(head) + if 0: + print("{}# mro: {}".format( + indent, ", ".join(c.__name__ for c in node.__class__.__mro__[1:]), + )) + next_indent = indent + " " + for field_name, value in named_fields: + prefix = f"{next_indent}{field_name}:" + if _is_simple_value(value): + print(f"{prefix} {value!r}") + elif isinstance(value, list): + print(f"{prefix} [") + for n in value: + ast_dump(n, depth + 8, print=print) + print(f"{next_indent}]") + else: + print(prefix) + ast_dump(value, depth + 8, print=print) - print(f"{indent}>") + print(f"{indent}>") diff --git a/tests/test_parser.py b/tests/test_parser.py index 82bf7616a..ff7d9ef9a 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -3,15 +3,17 @@ """Tests for coverage.py's code parsing.""" +import os.path +import re import textwrap import pytest from coverage import env from coverage.exceptions import NotPython -from coverage.parser import PythonParser +from coverage.parser import ast_dump, ast_parse, PythonParser -from tests.coveragetest import CoverageTest +from tests.coveragetest import CoverageTest, TESTS_DIR from tests.helpers import arcz_to_arcs @@ -477,3 +479,23 @@ def test_missing_line_ending(self): parser = self.parse_file("abrupt.py") assert parser.statements == {1} + + +def test_ast_dump(): + # Run the AST_DUMP code to make sure it doesn't fail, with some light + # assertions. Use parser.py as the test code since it is the longest file, + # and fitting, since it's the AST_DUMP code. + parser_py = os.path.join(TESTS_DIR, "../coverage/parser.py") + with open(parser_py) as f: + ast_root = ast_parse(f.read()) + result = [] + ast_dump(ast_root, print=result.append) + assert len(result) > 10000 + assert result[0] == "" + + def count(pat): + return sum(1 for line in result if re.search(pat, line)) + + assert count(r"^\s+>") > 2000 + assert count(r"") > 1000 From 0eaeb99f2de1330a562752d30d02d1898f681cf8 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 12 Oct 2021 08:46:25 -0400 Subject: [PATCH 006/137] fix: use human sorting on human-readable things --- CHANGES.rst | 4 +++- coverage/cmdline.py | 3 ++- coverage/collector.py | 4 ++-- coverage/control.py | 6 +++--- coverage/files.py | 4 ++-- coverage/html.py | 3 ++- coverage/misc.py | 31 +++++++++++++++++++++++++++++++ coverage/summary.py | 21 ++++++++++++--------- coverage/xmlreport.py | 8 ++++---- tests/test_misc.py | 21 +++++++++++++++++++++ tests/test_summary.py | 26 ++++++++++++++++++-------- 11 files changed, 100 insertions(+), 31 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index e45c54ac2..f2e2f1bce 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -23,7 +23,9 @@ This list is detailed and covers changes in each pre-release version. Unreleased ---------- -Nothing yet. +- When sorting human-readable names, numeric components are sorted correctly: + file10.py will appear after file9.py. This applies to file names, module + names, environment variables, and test contexts. .. _changes_602: diff --git a/coverage/cmdline.py b/coverage/cmdline.py index 1be155b80..dfdbd1c71 100644 --- a/coverage/cmdline.py +++ b/coverage/cmdline.py @@ -20,6 +20,7 @@ from coverage.debug import info_formatter, info_header, short_stack from coverage.exceptions import BaseCoverageException, ExceptionDuringRun, NoSource from coverage.execfile import PyRunner +from coverage.misc import human_sorted from coverage.results import Numbers, should_fail_under @@ -780,7 +781,7 @@ def do_debug(self, args): if data: print(f"has_arcs: {data.has_arcs()!r}") summary = line_counts(data, fullpath=True) - filenames = sorted(summary.keys()) + filenames = human_sorted(summary.keys()) print(f"\n{len(filenames)} files:") for f in filenames: line = f"{f}: {summary[f]} lines" diff --git a/coverage/collector.py b/coverage/collector.py index 73babf44e..733b6f323 100644 --- a/coverage/collector.py +++ b/coverage/collector.py @@ -10,7 +10,7 @@ from coverage.debug import short_stack from coverage.disposition import FileDisposition from coverage.exceptions import CoverageException -from coverage.misc import isolate_module +from coverage.misc import human_sorted, isolate_module from coverage.pytracer import PyTracer os = isolate_module(os) @@ -352,7 +352,7 @@ def pause(self): stats = tracer.get_stats() if stats: print("\nCoverage.py tracer stats:") - for k in sorted(stats.keys()): + for k in human_sorted(stats.keys()): print(f"{k:>20}: {stats[k]}") if self.threading: self.threading.settrace(None) diff --git a/coverage/control.py b/coverage/control.py index 8a55a3174..defe92099 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -26,7 +26,7 @@ from coverage.html import HtmlReporter from coverage.inorout import InOrOut from coverage.jsonreport import JsonReporter -from coverage.misc import bool_or_none, join_regex +from coverage.misc import bool_or_none, join_regex, human_sorted, human_sorted_items from coverage.misc import DefaultValue, ensure_dir_for_file, isolate_module from coverage.plugin import FileReporter from coverage.plugin_support import Plugins @@ -309,7 +309,7 @@ def _write_startup_debug(self): wrote_any = False with self._debug.without_callers(): if self._debug.should('config'): - config_info = sorted(self.config.__dict__.items()) + config_info = human_sorted_items(self.config.__dict__.items()) config_info = [(k, v) for k, v in config_info if not k.startswith('_')] write_formatted_info(self._debug, "config", config_info) wrote_any = True @@ -1076,7 +1076,7 @@ def plugin_info(plugins): ('pid', os.getpid()), ('cwd', os.getcwd()), ('path', sys.path), - ('environment', sorted( + ('environment', human_sorted( f"{k} = {v}" for k, v in os.environ.items() if ( diff --git a/coverage/files.py b/coverage/files.py index 686717447..6a4f5906d 100644 --- a/coverage/files.py +++ b/coverage/files.py @@ -14,7 +14,7 @@ from coverage import env from coverage.exceptions import CoverageException -from coverage.misc import contract, join_regex, isolate_module +from coverage.misc import contract, human_sorted, isolate_module, join_regex os = isolate_module(os) @@ -199,7 +199,7 @@ class TreeMatcher: """ def __init__(self, paths, name): - self.original_paths = sorted(paths) + self.original_paths = human_sorted(paths) self.paths = list(map(os.path.normcase, paths)) self.name = name diff --git a/coverage/html.py b/coverage/html.py index b095343ed..1fbac4b36 100644 --- a/coverage/html.py +++ b/coverage/html.py @@ -15,6 +15,7 @@ from coverage.exceptions import CoverageException from coverage.files import flat_rootname from coverage.misc import ensure_dir, file_be_gone, Hasher, isolate_module, format_local_datetime +from coverage.misc import human_sorted from coverage.report import get_analysis_to_report from coverage.results import Numbers from coverage.templite import Templite @@ -123,7 +124,7 @@ def data_for_file(self, fr, analysis): contexts = contexts_label = None context_list = None if category and self.config.show_contexts: - contexts = sorted(c or self.EMPTY for c in contexts_by_lineno.get(lineno, ())) + contexts = human_sorted(c or self.EMPTY for c in contexts_by_lineno.get(lineno, ())) if contexts == [self.EMPTY]: contexts_label = self.EMPTY else: diff --git a/coverage/misc.py b/coverage/misc.py index 29397537c..40f00930f 100644 --- a/coverage/misc.py +++ b/coverage/misc.py @@ -389,3 +389,34 @@ def import_local_file(modname, modfile=None): spec.loader.exec_module(mod) return mod + + +def human_key(s): + """Turn a string into a list of string and number chunks. + "z23a" -> ["z", 23, "a"] + """ + def tryint(s): + """If `s` is a number, return an int, else `s` unchanged.""" + try: + return int(s) + except ValueError: + return s + + return [tryint(c) for c in re.split(r"(\d+)", s)] + +def human_sorted(strings): + """Sort the given iterable of strings the way that humans expect. + + Numeric components in the strings are sorted as numbers. + + Returns the sorted list. + + """ + return sorted(strings, key=human_key) + +def human_sorted_items(items, reverse=False): + """Sort the (string, value) items the way humans expect. + + Returns the sorted list of items. + """ + return sorted(items, key=lambda pair: (human_key(pair[0]), pair[1]), reverse=reverse) diff --git a/coverage/summary.py b/coverage/summary.py index b7b172f89..0b54a05bf 100644 --- a/coverage/summary.py +++ b/coverage/summary.py @@ -6,6 +6,7 @@ import sys from coverage.exceptions import CoverageException +from coverage.misc import human_sorted_items from coverage.report import get_analysis_to_report from coverage.results import Numbers @@ -89,15 +90,17 @@ def report(self, morfs, outfile=None): lines.append((text, args)) # Sort the lines and write them out. - if getattr(self.config, 'sort', None): - sort_option = self.config.sort.lower() - reverse = False - if sort_option[0] == '-': - reverse = True - sort_option = sort_option[1:] - elif sort_option[0] == '+': - sort_option = sort_option[1:] - + sort_option = (self.config.sort or "name").lower() + reverse = False + if sort_option[0] == '-': + reverse = True + sort_option = sort_option[1:] + elif sort_option[0] == '+': + sort_option = sort_option[1:] + + if sort_option == "name": + lines = human_sorted_items(lines, reverse=reverse) + else: position = column_order.get(sort_option) if position is None: raise CoverageException(f"Invalid sorting option: {self.config.sort!r}") diff --git a/coverage/xmlreport.py b/coverage/xmlreport.py index 0538bfd5b..6dc330f16 100644 --- a/coverage/xmlreport.py +++ b/coverage/xmlreport.py @@ -10,7 +10,7 @@ import xml.dom.minidom from coverage import __url__, __version__, files -from coverage.misc import isolate_module +from coverage.misc import isolate_module, human_sorted, human_sorted_items from coverage.report import get_analysis_to_report os = isolate_module(os) @@ -77,7 +77,7 @@ def report(self, morfs, outfile=None): xcoverage.appendChild(xsources) # Populate the XML DOM with the source info. - for path in sorted(self.source_paths): + for path in human_sorted(self.source_paths): xsource = self.xml_out.createElement("source") xsources.appendChild(xsource) txt = self.xml_out.createTextNode(path) @@ -90,13 +90,13 @@ def report(self, morfs, outfile=None): xcoverage.appendChild(xpackages) # Populate the XML DOM with the package info. - for pkg_name, pkg_data in sorted(self.packages.items()): + for pkg_name, pkg_data in human_sorted_items(self.packages.items()): class_elts, lhits, lnum, bhits, bnum = pkg_data xpackage = self.xml_out.createElement("package") xpackages.appendChild(xpackage) xclasses = self.xml_out.createElement("classes") xpackage.appendChild(xclasses) - for _, class_elt in sorted(class_elts.items()): + for _, class_elt in human_sorted_items(class_elts.items()): xclasses.appendChild(class_elt) xpackage.setAttribute("name", pkg_name.replace(os.sep, '.')) xpackage.setAttribute("line-rate", rate(lhits, lnum)) diff --git a/tests/test_misc.py b/tests/test_misc.py index 740022322..58dba6a80 100644 --- a/tests/test_misc.py +++ b/tests/test_misc.py @@ -10,6 +10,7 @@ from coverage.exceptions import CoverageException from coverage.misc import contract, dummy_decorator_with_args, file_be_gone from coverage.misc import Hasher, one_of, substitute_variables, import_third_party +from coverage.misc import human_sorted, human_sorted_items from coverage.misc import USE_CONTRACTS from tests.coveragetest import CoverageTest @@ -180,3 +181,23 @@ def test_failure(self): mod = import_third_party("xyzzy") assert mod is None assert "xyzzy" not in sys.modules + + +HUMAN_DATA = [ + ("z1 a2z a2a a3 a1", "a1 a2a a2z a3 z1"), + ("a10 a9 a100 a1", "a1 a9 a10 a100"), + ("4.0 3.10-win 3.10-mac 3.9-mac 3.9-win", "3.9-mac 3.9-win 3.10-mac 3.10-win 4.0"), +] + +@pytest.mark.parametrize("words, ordered", HUMAN_DATA) +def test_human_sorted(words, ordered): + assert " ".join(human_sorted(words.split())) == ordered + +@pytest.mark.parametrize("words, ordered", HUMAN_DATA) +def test_human_sorted_items(words, ordered): + keys = words.split() + items = [(k, 1) for k in keys] + [(k, 2) for k in keys] + okeys = ordered.split() + oitems = [(k, v) for k in okeys for v in [1, 2]] + assert human_sorted_items(items) == oitems + assert human_sorted_items(items, reverse=True) == oitems[::-1] diff --git a/tests/test_summary.py b/tests/test_summary.py index b71921c74..4dbd3c085 100644 --- a/tests/test_summary.py +++ b/tests/test_summary.py @@ -847,8 +847,8 @@ def get_summary_text(self, *options): """ self.make_rigged_file("file1.py", 339, 155) self.make_rigged_file("file2.py", 13, 3) - self.make_rigged_file("file3.py", 234, 228) - self.make_file("doit.py", "import file1, file2, file3") + self.make_rigged_file("file10.py", 234, 228) + self.make_file("doit.py", "import file1, file2, file10") cov = Coverage(source=["."], omit=["doit.py"]) cov.start() @@ -871,7 +871,7 @@ def test_test_data(self): # ------------------------------ # file1.py 339 155 54% # file2.py 13 3 77% - # file3.py 234 228 3% + # file10.py 234 228 3% # ------------------------------ # TOTAL 586 386 34% @@ -906,30 +906,40 @@ def assert_ordering(self, text, *words): msg = f"The words {words!r} don't appear in order in {text!r}" assert indexes == sorted(indexes), msg + def test_default_sort_report(self): + # Sort the text report by the default (Name) column. + report = self.get_summary_text() + self.assert_ordering(report, "file1.py", "file2.py", "file10.py") + + def test_sort_report_by_name(self): + # Sort the text report explicitly by the Name column. + report = self.get_summary_text(('report:sort', 'Name')) + self.assert_ordering(report, "file1.py", "file2.py", "file10.py") + def test_sort_report_by_stmts(self): # Sort the text report by the Stmts column. report = self.get_summary_text(('report:sort', 'Stmts')) - self.assert_ordering(report, "file2.py", "file3.py", "file1.py") + self.assert_ordering(report, "file2.py", "file10.py", "file1.py") def test_sort_report_by_missing(self): # Sort the text report by the Missing column. report = self.get_summary_text(('report:sort', 'Miss')) - self.assert_ordering(report, "file2.py", "file1.py", "file3.py") + self.assert_ordering(report, "file2.py", "file1.py", "file10.py") def test_sort_report_by_cover(self): # Sort the text report by the Cover column. report = self.get_summary_text(('report:sort', 'Cover')) - self.assert_ordering(report, "file3.py", "file1.py", "file2.py") + self.assert_ordering(report, "file10.py", "file1.py", "file2.py") def test_sort_report_by_cover_plus(self): # Sort the text report by the Cover column, including the explicit + sign. report = self.get_summary_text(('report:sort', '+Cover')) - self.assert_ordering(report, "file3.py", "file1.py", "file2.py") + self.assert_ordering(report, "file10.py", "file1.py", "file2.py") def test_sort_report_by_cover_reversed(self): # Sort the text report by the Cover column reversed. report = self.get_summary_text(('report:sort', '-Cover')) - self.assert_ordering(report, "file2.py", "file1.py", "file3.py") + self.assert_ordering(report, "file2.py", "file1.py", "file10.py") def test_sort_report_by_invalid_option(self): # Sort the text report by a nonsense column. From e982dacef6cf67035c0d57a959e24c1bd4205fb1 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 12 Oct 2021 09:47:15 -0400 Subject: [PATCH 007/137] test: add a test that self.stdout() works the way it says. --- tests/test_testing.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tests/test_testing.py b/tests/test_testing.py index eae18890a..37130074c 100644 --- a/tests/test_testing.py +++ b/tests/test_testing.py @@ -203,6 +203,15 @@ def test_run_command_stdout_stderr(self): assert "StdOut\n" in out assert "StdErr\n" in out + def test_stdout(self): + # stdout is captured. + print("This is stdout") + print("Line 2") + assert self.stdout() == "This is stdout\nLine 2\n" + # When we grab stdout(), it's reset. + print("Some more") + assert self.stdout() == "Some more\n" + class CheckUniqueFilenamesTest(CoverageTest): """Tests of CheckUniqueFilenames.""" From de00789a23dc030fbbcd4814ff3478c307b70bb4 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 12 Oct 2021 17:06:52 -0400 Subject: [PATCH 008/137] test: we really don't want to hear about imp being deprecated --- tests/conftest.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/conftest.py b/tests/conftest.py index 75adf3f24..d3fd1538e 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -51,6 +51,11 @@ def set_warnings(): category=ImportWarning, message=r".*find_spec\(\) not found; falling back to find_module\(\)", ) + warnings.filterwarnings( + "ignore", + category=DeprecationWarning, + message=r".*imp module is deprecated in favour of importlib", + ) if env.PYPY: # pypy3 warns about unclosed files a lot. From a219b17fd967de796b446bc8626a7822902d7fd7 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 12 Oct 2021 17:18:49 -0400 Subject: [PATCH 009/137] refactor: convert existing imports to start_stop_import --- tests/test_summary.py | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/tests/test_summary.py b/tests/test_summary.py index 4dbd3c085..f233b2fb2 100644 --- a/tests/test_summary.py +++ b/tests/test_summary.py @@ -674,18 +674,14 @@ def branch(x): print("y") """) cov = coverage.Coverage(branch=True, source=["."]) - cov.start() - import main # pragma: nested # pylint: disable=unused-import, import-error - cov.stop() # pragma: nested + self.start_import_stop(cov, "main") report = self.get_report(cov).splitlines() assert "mybranch.py 5 5 2 0 0%" in report def run_TheCode_and_report_it(self): """A helper for the next few tests.""" cov = coverage.Coverage() - cov.start() - import TheCode # pragma: nested # pylint: disable=import-error, unused-import - cov.stop() # pragma: nested + self.start_import_stop(cov, "TheCode") return self.get_report(cov) def test_bug_203_mixed_case_listed_twice_with_rc(self): @@ -716,6 +712,7 @@ def test_pyw_files(self): print("In mod.pyw") """) cov = coverage.Coverage() + # start_import_stop can't import the .pyw file, so use the long form. cov.start() import start # pragma: nested # pylint: disable=import-error, unused-import cov.stop() # pragma: nested @@ -736,9 +733,7 @@ def test_tracing_pyc_file(self): # Run the program. cov = coverage.Coverage() - cov.start() - import main # pragma: nested # pylint: disable=unused-import, import-error - cov.stop() # pragma: nested + self.start_import_stop(cov, "main") report = self.get_report(cov).splitlines() assert "mod.py 1 0 100%" in report @@ -762,9 +757,7 @@ def test_missing_py_file_during_run(self): # Run the program. cov = coverage.Coverage() - cov.start() - import main # pragma: nested # pylint: disable=unused-import, import-error - cov.stop() # pragma: nested + self.start_import_stop(cov, "main") # Put back the missing Python file. self.make_file("mod.py", "a = 1\n") @@ -851,9 +844,7 @@ def get_summary_text(self, *options): self.make_file("doit.py", "import file1, file2, file10") cov = Coverage(source=["."], omit=["doit.py"]) - cov.start() - import doit # pragma: nested # pylint: disable=import-error, unused-import - cov.stop() # pragma: nested + self.start_import_stop(cov, "doit") for name, value in options: cov.set_option(name, value) printer = SummaryReporter(cov) From b81754ad52fb63038898533d9b155aa2f7650399 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 13 Oct 2021 06:02:28 -0400 Subject: [PATCH 010/137] refactor: no longer need to explicitly omit site-packages 6.x omits site-packages automatically. --- tests/test_summary.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/tests/test_summary.py b/tests/test_summary.py index f233b2fb2..9b225c9ed 100644 --- a/tests/test_summary.py +++ b/tests/test_summary.py @@ -33,14 +33,6 @@ def make_mycode(self): a = 1 print('done') """) - self.omit_site_packages() - - def omit_site_packages(self): - """Write a .coveragerc file that will omit site-packages from reports.""" - self.make_file(".coveragerc", """\ - [report] - omit = */site-packages/* - """) def test_report(self): self.make_mycode() @@ -237,7 +229,6 @@ def branch(x, y): print("y") branch(1, 1) """) - self.omit_site_packages() out = self.run_command("coverage run --branch mybranch.py") assert out == 'x\ny\n' report = self.report_from_command("coverage report --show-missing") @@ -269,7 +260,6 @@ def branch(x, y, z): return x branch(1, 1, 0) """) - self.omit_site_packages() out = self.run_command("coverage run --branch main.py") assert out == 'x\ny\n' report = self.report_from_command("coverage report --show-missing") @@ -297,7 +287,6 @@ def normal(): def not_covered(): print("n") """) - self.omit_site_packages() out = self.run_command("coverage run main.py") assert out == "z\n" report = self.report_from_command("coverage report --skip-covered --fail-under=70") @@ -338,7 +327,6 @@ def foo(): pass foo() """) - self.omit_site_packages() out = self.run_command("coverage run --branch main.py") assert out == "n\nz\n" report = self.report_from_command("coverage report --skip-covered") @@ -378,7 +366,6 @@ def not_covered(n): def does_not_appear_in_this_film(ni): print("Ni!") """) - self.omit_site_packages() out = self.run_command("coverage run --branch main.py") assert out == "n\nz\n" report = self.report_from_command("coverage report --skip-covered") @@ -461,7 +448,6 @@ def normal(): normal() """) self.make_file("submodule/__init__.py", "") - self.omit_site_packages() out = self.run_command("coverage run main.py") assert out == "z\n" report = self.report_from_command("coverage report --skip-empty") @@ -483,7 +469,6 @@ def normal(): def test_report_skip_empty_no_data(self): self.make_file("__init__.py", "") - self.omit_site_packages() out = self.run_command("coverage run __init__.py") assert out == "" report = self.report_from_command("coverage report --skip-empty") From d137a41da2f1a7010a1bd4305962670af2f7dae1 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 13 Oct 2021 06:03:12 -0400 Subject: [PATCH 011/137] refactor: use the get_report helper --- tests/test_summary.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/tests/test_summary.py b/tests/test_summary.py index 9b225c9ed..fc67e8a9c 100644 --- a/tests/test_summary.py +++ b/tests/test_summary.py @@ -756,12 +756,7 @@ def test_empty_files(self): cov.start() import usepkgs # pragma: nested # pylint: disable=import-error, unused-import cov.stop() # pragma: nested - - repout = io.StringIO() - cov.report(file=repout, show_missing=False) - - report = repout.getvalue().replace('\\', '/') - report = re.sub(r"\s+", " ", report) + report = self.get_report(cov) assert "tests/modules/pkg1/__init__.py 1 0 0 0 100%" in report assert "tests/modules/pkg2/__init__.py 0 0 0 0 100%" in report From 001f6532f8a8bf05f1cf6f2b5574ba091550a77d Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Wed, 13 Oct 2021 06:47:57 -0400 Subject: [PATCH 012/137] test: don't use subprocesses where we don't have to When running tests with `-n 0`, this shaves 4 seconds off the run time. When running the complete test suite with xdist, it takes 2 seconds longer!? --- tests/coveragetest.py | 11 +++++ tests/test_arcs.py | 7 +-- tests/test_summary.py | 112 ++++++++++++++++++++++-------------------- 3 files changed, 74 insertions(+), 56 deletions(-) diff --git a/tests/coveragetest.py b/tests/coveragetest.py index aae4df08a..aad711342 100644 --- a/tests/coveragetest.py +++ b/tests/coveragetest.py @@ -78,6 +78,16 @@ def start_import_stop(self, cov, modname, modfile=None): cov.stop() return mod + def get_report(self, cov, squeeze=True, **kwargs): + """Get the report from `cov`, and canonicalize it.""" + repout = io.StringIO() + kwargs.setdefault("show_missing", False) + cov.report(file=repout, **kwargs) + report = repout.getvalue().replace('\\', '/') + if squeeze: + report = re.sub(r" +", " ", report) + return report + def get_module_name(self): """Return a random module name to use for this test run.""" self.last_module_name = 'coverage_test_' + str(random.random())[2:] @@ -451,6 +461,7 @@ def setup_test(self): # Parent class saves and restores sys.path, we can just modify it. sys.path.append(nice_file(TESTS_DIR, "modules")) sys.path.append(nice_file(TESTS_DIR, "moremodules")) + sys.path.append(nice_file(TESTS_DIR, "zipmods.zip")) def command_line(args): diff --git a/tests/test_arcs.py b/tests/test_arcs.py index 6cdc908e1..1284badc9 100644 --- a/tests/test_arcs.py +++ b/tests/test_arcs.py @@ -462,8 +462,9 @@ def method(self): while True: return 1 """) - out = self.run_command("coverage run --branch --source=. main.py") - assert out == 'done\n' + cov = coverage.Coverage(source=["."], branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == 'done\n' if env.PYBEHAVIOR.keep_constant_test: num_stmts = 3 elif env.PYBEHAVIOR.nix_while_true: @@ -471,7 +472,7 @@ def method(self): else: num_stmts = 3 expected = "zero.py {n} {n} 0 0 0% 1-3".format(n=num_stmts) - report = self.report_from_command("coverage report -m") + report = self.get_report(cov, show_missing=True) squeezed = self.squeezed_lines(report) assert expected in squeezed[3] diff --git a/tests/test_summary.py b/tests/test_summary.py index fc67e8a9c..03660542f 100644 --- a/tests/test_summary.py +++ b/tests/test_summary.py @@ -36,9 +36,10 @@ def make_mycode(self): def test_report(self): self.make_mycode() - out = self.run_command("coverage run mycode.py") - assert out == 'done\n' - report = self.report_from_command("coverage report") + cov = coverage.Coverage() + self.start_import_stop(cov, "mycode") + assert self.stdout() == 'done\n' + report = self.get_report(cov) # Name Stmts Miss Cover # ------------------------------------------------------------------ @@ -57,8 +58,9 @@ def test_report(self): def test_report_just_one(self): # Try reporting just one module self.make_mycode() - self.run_command("coverage run mycode.py") - report = self.report_from_command("coverage report mycode.py") + cov = coverage.Coverage() + self.start_import_stop(cov, "mycode") + report = self.get_report(cov, morfs=["mycode.py"]) # Name Stmts Miss Cover # ------------------------------- @@ -76,6 +78,7 @@ def test_report_just_one(self): def test_report_wildcard(self): # Try reporting using wildcards to get the modules. self.make_mycode() + # Wildcard is handled by shell or cmdline.py, so use real commands self.run_command("coverage run mycode.py") report = self.report_from_command("coverage report my*.py") @@ -95,9 +98,9 @@ def test_report_wildcard(self): def test_report_omitting(self): # Try reporting while omitting some modules self.make_mycode() - self.run_command("coverage run mycode.py") - omit = f'{TESTS_DIR}/*,*/site-packages/*' - report = self.report_from_command(f"coverage report --omit '{omit}'") + cov = coverage.Coverage() + self.start_import_stop(cov, "mycode") + report = self.get_report(cov, omit=[f"{TESTS_DIR}/*", "*/site-packages/*"]) # Name Stmts Miss Cover # ------------------------------- @@ -115,8 +118,9 @@ def test_report_omitting(self): def test_report_including(self): # Try reporting while including some modules self.make_mycode() - self.run_command("coverage run mycode.py") - report = self.report_from_command("coverage report --include=mycode*") + cov = coverage.Coverage() + self.start_import_stop(cov, "mycode") + report = self.get_report(cov, include=["mycode*"]) # Name Stmts Miss Cover # ------------------------------- @@ -174,9 +178,10 @@ def branch(x): return x branch(1) """) - out = self.run_command("coverage run --source=. --branch mybranch.py") - assert out == 'x\n' - report = self.report_from_command("coverage report") + cov = coverage.Coverage(source=["."], branch=True) + self.start_import_stop(cov, "mybranch") + assert self.stdout() == 'x\n' + report = self.get_report(cov) # Name Stmts Miss Branch BrPart Cover # ----------------------------------------------- @@ -205,9 +210,10 @@ def missing(x, y): return x missing(0, 1) """) - out = self.run_command("coverage run --source=. mymissing.py") - assert out == 'y\nz\n' - report = self.report_from_command("coverage report --show-missing") + cov = coverage.Coverage(source=["."]) + self.start_import_stop(cov, "mymissing") + assert self.stdout() == 'y\nz\n' + report = self.get_report(cov, show_missing=True) # Name Stmts Miss Cover Missing # -------------------------------------------- @@ -229,9 +235,10 @@ def branch(x, y): print("y") branch(1, 1) """) - out = self.run_command("coverage run --branch mybranch.py") - assert out == 'x\ny\n' - report = self.report_from_command("coverage report --show-missing") + cov = coverage.Coverage(branch=True) + self.start_import_stop(cov, "mybranch") + assert self.stdout() == 'x\ny\n' + report = self.get_report(cov, show_missing=True) # Name Stmts Miss Branch BrPart Cover Missing # ---------------------------------------------------------- @@ -260,10 +267,10 @@ def branch(x, y, z): return x branch(1, 1, 0) """) - out = self.run_command("coverage run --branch main.py") - assert out == 'x\ny\n' - report = self.report_from_command("coverage report --show-missing") - report_lines = report.splitlines() + cov = coverage.Coverage(branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == 'x\ny\n' + report_lines = self.get_report(cov, squeeze=False, show_missing=True).splitlines() expected = [ 'Name Stmts Miss Branch BrPart Cover Missing', @@ -287,6 +294,7 @@ def normal(): def not_covered(): print("n") """) + # --fail-under is handled by cmdline.py, use real commands. out = self.run_command("coverage run main.py") assert out == "z\n" report = self.report_from_command("coverage report --skip-covered --fail-under=70") @@ -327,9 +335,10 @@ def foo(): pass foo() """) - out = self.run_command("coverage run --branch main.py") - assert out == "n\nz\n" - report = self.report_from_command("coverage report --skip-covered") + cov = coverage.Coverage(branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == "n\nz\n" + report = self.get_report(cov, skip_covered=True) # Name Stmts Miss Branch BrPart Cover # -------------------------------------------------- @@ -366,9 +375,10 @@ def not_covered(n): def does_not_appear_in_this_film(ni): print("Ni!") """) - out = self.run_command("coverage run --branch main.py") - assert out == "n\nz\n" - report = self.report_from_command("coverage report --skip-covered") + cov = coverage.Coverage(branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == "n\nz\n" + report = self.get_report(cov, skip_covered=True) # Name Stmts Miss Branch BrPart Cover # -------------------------------------------------- @@ -392,9 +402,10 @@ def foo(): pass foo() """) - out = self.run_command("coverage run --source=. --branch main.py") - assert out == "" - report = self.report_from_command("coverage report --skip-covered") + cov = coverage.Coverage(source=["."], branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == "" + report = self.get_report(cov, skip_covered=True) # Name Stmts Miss Branch BrPart Cover # ------------------------------------------- @@ -413,9 +424,10 @@ def foo(): pass foo() """) - out = self.run_command("coverage run --source=. --branch long_______________filename.py") - assert out == "" - report = self.report_from_command("coverage report --skip-covered") + cov = coverage.Coverage(source=["."], branch=True) + self.start_import_stop(cov, "long_______________filename") + assert self.stdout() == "" + report = self.get_report(cov, squeeze=False, skip_covered=True) # Name Stmts Miss Branch BrPart Cover # ----------------------------------------- @@ -448,9 +460,10 @@ def normal(): normal() """) self.make_file("submodule/__init__.py", "") - out = self.run_command("coverage run main.py") - assert out == "z\n" - report = self.report_from_command("coverage report --skip-empty") + cov = coverage.Coverage() + self.start_import_stop(cov, "main") + assert self.stdout() == "z\n" + report = self.get_report(cov, skip_empty=True) # Name Stmts Miss Cover # ------------------------------------ @@ -465,13 +478,13 @@ def normal(): assert squeezed[2] == "main.py 4 0 100%" assert squeezed[4] == "TOTAL 4 0 100%" assert squeezed[6] == "1 empty file skipped." - assert self.last_command_status == 0 def test_report_skip_empty_no_data(self): self.make_file("__init__.py", "") - out = self.run_command("coverage run __init__.py") - assert out == "" - report = self.report_from_command("coverage report --skip-empty") + cov = coverage.Coverage() + self.start_import_stop(cov, "__init__") + assert self.stdout() == "" + report = self.get_report(cov, skip_empty=True) # Name Stmts Miss Cover # ------------------------------------ @@ -509,9 +522,10 @@ def foo(): pass foo() """) - out = self.run_command("coverage run --branch main.py") - assert out == "n\nz\n" - report = self.report_from_command("coverage report") + cov = coverage.Coverage(branch=True) + self.start_import_stop(cov, "main") + assert self.stdout() == "n\nz\n" + report = self.get_report(cov) # Name Stmts Miss Branch BrPart Cover # ------------------------------------------------------ @@ -638,14 +652,6 @@ def test_report_with_chdir(self): report = self.report_from_command("coverage report") assert self.last_line_squeezed(report) == "TOTAL 5 0 100%" - def get_report(self, cov): - """Get the report from `cov`, and canonicalize it.""" - repout = io.StringIO() - cov.report(file=repout, show_missing=False) - report = repout.getvalue().replace('\\', '/') - report = re.sub(r" +", " ", report) - return report - def test_bug_156_file_not_run_should_be_zero(self): # https://github.com/nedbat/coveragepy/issues/156 self.make_file("mybranch.py", """\ From 2e39e43d79b5ba38e5d3e693e847d6334462b55d Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 14 Oct 2021 10:45:55 -0400 Subject: [PATCH 013/137] style(docs): clean up a trailing blank line --- doc/changes.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/changes.rst b/doc/changes.rst index 80b75da79..6fb009d0d 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -2792,4 +2792,3 @@ and 2.1.1. 2002-01-07 GDR Update sys.path when running a file with the -x option, so that it matches the value the program would get if it were run on its own. - From a1101953f253754514e74d3d648c4d4ef9c0ad6c Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 14 Oct 2021 11:14:27 -0400 Subject: [PATCH 014/137] test: parametrize test_pathologically_long_code_object While experimenting with packing branch ends into one int, this test showed a mistake I had made. Turns out it wasn't an obsolete test after all. --- tests/test_arcs.py | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/tests/test_arcs.py b/tests/test_arcs.py index 1284badc9..f4a11839f 100644 --- a/tests/test_arcs.py +++ b/tests/test_arcs.py @@ -1613,28 +1613,25 @@ def test_unpacked_literals(self): arcz=".1 15 5A A." ) - def test_pathologically_long_code_object(self): + @pytest.mark.parametrize("n", [10, 50, 100, 500, 1000, 2000, 10000]) + def test_pathologically_long_code_object(self, n): # https://github.com/nedbat/coveragepy/issues/359 - # The structure of this file is such that an EXTENDED_ARG bytecode is - # needed to encode the jump at the end. We weren't interpreting those - # opcodes. - # Note that we no longer interpret bytecode at all, but it couldn't - # hurt to keep the test... - sizes = [10, 50, 100, 500, 1000, 2000] - for n in sizes: - code = """\ - data = [ - """ + "".join("""\ - [ - {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}], - """.format(i=i) for i in range(n) - ) + """\ - ] - - print(len(data)) - """ - self.check_coverage(code, arcs=[(-1, 1), (1, 2*n+4), (2*n+4, -1)]) - assert self.stdout().split() == [str(n) for n in sizes] + # Long code objects sometimes cause problems. Originally, it was + # due to EXTENDED_ARG bytes codes. Then it showed a mistake in + # line-number packing. + code = """\ + data = [ + """ + "".join("""\ + [ + {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}, {i}], + """.format(i=i) for i in range(n) + ) + """\ + ] + + print(len(data)) + """ + self.check_coverage(code, arcs=[(-1, 1), (1, 2*n+4), (2*n+4, -1)]) + assert self.stdout() == f"{n}\n" def test_partial_generators(self): # https://github.com/nedbat/coveragepy/issues/475 From ec9070f1387e9713236f3b8c47447df44447df23 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 14 Oct 2021 20:03:20 -0400 Subject: [PATCH 015/137] perf: reduce the overhead of recording branches --- CHANGES.rst | 3 +++ coverage/collector.py | 22 +++++++++++++++++++++- coverage/ctracer/tracer.c | 30 +++++++++++++++++++++++------- coverage/ctracer/util.h | 5 +++++ 4 files changed, 52 insertions(+), 8 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index f2e2f1bce..81e02732a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -27,6 +27,9 @@ Unreleased file10.py will appear after file9.py. This applies to file names, module names, environment variables, and test contexts. +- Branch coverage measurement is faster, though you might only notice on + code that is executed many times, such as long-running loops. + .. _changes_602: diff --git a/coverage/collector.py b/coverage/collector.py index 733b6f323..a72129e23 100644 --- a/coverage/collector.py +++ b/coverage/collector.py @@ -157,9 +157,11 @@ def __init__( if self._trace_class is CTracer: self.file_disposition_class = CFileDisposition self.supports_plugins = True + self.packed_arcs = True else: self.file_disposition_class = FileDisposition self.supports_plugins = False + self.packed_arcs = False def __repr__(self): return f"" @@ -437,7 +439,25 @@ def flush_data(self): return False if self.branch: - self.covdata.add_arcs(self.mapped_file_dict(self.data)) + if self.packed_arcs: + # Unpack the line number pairs packed into integers. See + # tracer.c:CTracer_record_pair for the C code that creates + # these packed ints. + data = {} + for fname, packeds in self.data.items(): + tuples = [] + for packed in packeds: + l1 = packed & 0xFFFFF + l2 = (packed & (0xFFFFF << 20)) >> 20 + if packed & (1 << 40): + l1 *= -1 + if packed & (1 << 41): + l2 *= -1 + tuples.append((l1, l2)) + data[fname] = tuples + else: + data = self.data + self.covdata.add_arcs(self.mapped_file_dict(data)) else: self.covdata.add_lines(self.mapped_file_dict(self.data)) diff --git a/coverage/ctracer/tracer.c b/coverage/ctracer/tracer.c index 00d9f106a..cf5bebb15 100644 --- a/coverage/ctracer/tracer.c +++ b/coverage/ctracer/tracer.c @@ -174,22 +174,38 @@ static int CTracer_record_pair(CTracer *self, int l1, int l2) { int ret = RET_ERROR; - - PyObject * t = NULL; - - t = Py_BuildValue("(ii)", l1, l2); - if (t == NULL) { + PyObject * packed_obj = NULL; + uint64 packed = 0; + + // Conceptually, data is a set of tuples (l1, l2), but that literally + // making a set of tuples would require us to construct a tuple just to + // see if we'd already recorded an arc. On many-times-executed code, + // that would mean we construct a tuple, find the tuple is already in the + // set, then discard the tuple. We can avoid that overhead by packing + // the two line numbers into one integer instead. + // See collector.py:flush_data for the Python code that unpacks this. + if (l1 < 0) { + packed |= (1LL << 40); + l1 = -l1; + } + if (l2 < 0) { + packed |= (1LL << 41); + l2 = -l2; + } + packed |= (((uint64)l2) << 20) + (uint64)l1; + packed_obj = PyLong_FromUnsignedLongLong(packed); + if (packed_obj == NULL) { goto error; } - if (PySet_Add(self->pcur_entry->file_data, t) < 0) { + if (PySet_Add(self->pcur_entry->file_data, packed_obj) < 0) { goto error; } ret = RET_OK; error: - Py_XDECREF(t); + Py_XDECREF(packed_obj); return ret; } diff --git a/coverage/ctracer/util.h b/coverage/ctracer/util.h index a0b0e236e..413433d7b 100644 --- a/coverage/ctracer/util.h +++ b/coverage/ctracer/util.h @@ -36,6 +36,11 @@ typedef int BOOL; #define FALSE 0 #define TRUE 1 +#if SIZEOF_LONG_LONG < 8 +#error long long too small! +#endif +typedef unsigned long long uint64; + /* Only for extreme machete-mode debugging! */ #define CRASH { printf("*** CRASH! ***\n"); *((int*)1) = 1; } From 4a5cf280fe8622a4ccd03c07cdd6adf3207df20f Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 14 Oct 2021 20:03:57 -0400 Subject: [PATCH 016/137] test: we don't need two sys.path restorers --- tests/coveragetest.py | 4 ++-- tests/mixins.py | 13 ++----------- tests/test_mixins.py | 4 ++-- 3 files changed, 6 insertions(+), 15 deletions(-) diff --git a/tests/coveragetest.py b/tests/coveragetest.py index aad711342..a4e0ee026 100644 --- a/tests/coveragetest.py +++ b/tests/coveragetest.py @@ -24,7 +24,7 @@ from tests.helpers import arcs_to_arcz_repr, arcz_to_arcs, assert_count_equal from tests.helpers import nice_file, run_command -from tests.mixins import PytestBase, StdStreamCapturingMixin, SysPathModulesMixin, TempDirMixin +from tests.mixins import PytestBase, StdStreamCapturingMixin, RestoreModulesMixin, TempDirMixin # Status returns for the command line. @@ -36,7 +36,7 @@ class CoverageTest( StdStreamCapturingMixin, - SysPathModulesMixin, + RestoreModulesMixin, TempDirMixin, PytestBase, ): diff --git a/tests/mixins.py b/tests/mixins.py index 95b2145a3..4a3347b27 100644 --- a/tests/mixins.py +++ b/tests/mixins.py @@ -82,17 +82,8 @@ def make_file(self, filename, text="", bytes=b"", newline=None): return make_file(filename, text, bytes, newline) -class SysPathModulesMixin: - """Auto-restore sys.path and the imported modules at the end of each test.""" - - @pytest.fixture(autouse=True) - def _save_sys_path(self): - """Restore sys.path at the end of each test.""" - old_syspath = sys.path[:] - try: - yield - finally: - sys.path = old_syspath +class RestoreModulesMixin: + """Auto-restore the imported modules at the end of each test.""" @pytest.fixture(autouse=True) def _module_saving(self): diff --git a/tests/test_mixins.py b/tests/test_mixins.py index 1483b1a2b..5692c334b 100644 --- a/tests/test_mixins.py +++ b/tests/test_mixins.py @@ -7,7 +7,7 @@ from coverage.misc import import_local_file -from tests.mixins import TempDirMixin, SysPathModulesMixin +from tests.mixins import TempDirMixin, RestoreModulesMixin class TempDirMixinTest(TempDirMixin): @@ -59,7 +59,7 @@ def test_make_bytes_file(self): assert data == b"\x99\x33\x66hello\0" -class SysPathModulessMixinTest(TempDirMixin, SysPathModulesMixin): +class RestoreModulessMixinTest(TempDirMixin, RestoreModulesMixin): """Tests of SysPathModulesMixin.""" @pytest.mark.parametrize("val", [17, 42]) From e4c3d3007bce562f1fbdc2d2029a4bcbeaf8cd08 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Thu, 14 Oct 2021 21:35:34 -0400 Subject: [PATCH 017/137] test: mark some uncovered lines in collector.py --- coverage/collector.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/coverage/collector.py b/coverage/collector.py index a72129e23..6f9aa2c16 100644 --- a/coverage/collector.py +++ b/coverage/collector.py @@ -21,7 +21,7 @@ from coverage.tracer import CTracer, CFileDisposition except ImportError: # Couldn't import the C extension, maybe it isn't built. - if os.getenv('COVERAGE_TEST_TRACER') == 'c': + if os.getenv('COVERAGE_TEST_TRACER') == 'c': # pragma: part covered # During testing, we use the COVERAGE_TEST_TRACER environment variable # to indicate that we've fiddled with the environment to test this # fallback code. If we thought we had a C tracer, but couldn't import @@ -411,15 +411,15 @@ def mapped_file_dict(self, d): # in other threads. We try three times in case of concurrent # access, hoping to get a clean copy. runtime_err = None - for _ in range(3): + for _ in range(3): # pragma: part covered try: items = list(d.items()) - except RuntimeError as ex: + except RuntimeError as ex: # pragma: cant happen runtime_err = ex else: break else: - raise runtime_err + raise runtime_err # pragma: cant happen return {self.cached_mapped_file(k): v for k, v in items if v} From aab6c32ca0fb290da7d31aaad9a6e9893240be26 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 16 Oct 2021 07:41:53 -0400 Subject: [PATCH 018/137] test: subprocess diagnostic for when we need it --- tests/helpers.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/helpers.py b/tests/helpers.py index c85a36cb4..1420bed7e 100644 --- a/tests/helpers.py +++ b/tests/helpers.py @@ -24,6 +24,12 @@ def run_command(cmd): Returns the exit status code and the combined stdout and stderr. """ + # Subprocesses are expensive, but convenient, and so may be over-used in + # the test suite. Use these lines to get a list of the tests using them: + if 0: # pragma: debugging + with open("/tmp/processes.txt", "a") as proctxt: + print(os.environ.get("PYTEST_CURRENT_TEST", "unknown"), file=proctxt, flush=True) + # In some strange cases (PyPy3 in a virtualenv!?) the stdout encoding of # the subprocess is set incorrectly to ascii. Use an environment variable # to force the encoding to be the same as ours. From 702c927fed2b2120ed2e4aa66668170d4120ca30 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 16 Oct 2021 07:42:17 -0400 Subject: [PATCH 019/137] test: very minor clean up --- tests/test_process.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/test_process.py b/tests/test_process.py index a31350498..c9a2f8eea 100644 --- a/tests/test_process.py +++ b/tests/test_process.py @@ -263,7 +263,6 @@ def test_combine_parallel_data_keep(self): self.assert_exists(".coverage") self.assert_file_count(".coverage.*", 2) - def test_append_data(self): self.make_b_or_c_py() @@ -830,6 +829,10 @@ def foo(): def test_module_name(self): # https://github.com/nedbat/coveragepy/issues/478 + # Make sure help doesn't show a silly command name when run as a + # module, like it used to: + # $ python -m coverage + # Code coverage for Python. Use '__main__.py help' for help. out = self.run_command("python -m coverage") assert "Use 'coverage help' for help" in out From 99cf3cbd331e03750e1a251d36d1849dc59b427e Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 16 Oct 2021 08:16:38 -0400 Subject: [PATCH 020/137] feat: `coverage run` now sets the COVERAGE_RUN environment variable --- CHANGES.rst | 16 +++++++++++----- coverage/cmdline.py | 3 +++ coverage/version.py | 2 +- doc/cmd.rst | 4 ++++ tests/test_process.py | 17 ++++++++++++++++- 5 files changed, 35 insertions(+), 7 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 81e02732a..95b34a774 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -23,12 +23,18 @@ This list is detailed and covers changes in each pre-release version. Unreleased ---------- -- When sorting human-readable names, numeric components are sorted correctly: - file10.py will appear after file9.py. This applies to file names, module - names, environment variables, and test contexts. +- Feature: Coverage now sets an environment variable, ``COVERAGE_RUN`` when + running your code with the ``coverage run`` command. The value is not + important, and may change in the future. Closes `issue 553`_. -- Branch coverage measurement is faster, though you might only notice on - code that is executed many times, such as long-running loops. +- Fix: When sorting human-readable names, numeric components are sorted + correctly: file10.py will appear after file9.py. This applies to file names, + module names, environment variables, and test contexts. + +- Performance: Branch coverage measurement is faster, though you might only + notice on code that is executed many times, such as long-running loops. + + .. _issue 553: https://github.com/nedbat/coveragepy/issues/553 .. _changes_602: diff --git a/coverage/cmdline.py b/coverage/cmdline.py index dfdbd1c71..5f972035f 100644 --- a/coverage/cmdline.py +++ b/coverage/cmdline.py @@ -6,6 +6,7 @@ import glob import optparse # pylint: disable=deprecated-module +import os import os.path import shlex import sys @@ -739,6 +740,8 @@ def do_run(self, options, args): ) return ERR + os.environ["COVERAGE_RUN"] = "true" + runner = PyRunner(args, as_module=bool(options.module)) runner.prepare() diff --git a/coverage/version.py b/coverage/version.py index 8aa3bcf72..2b96b696c 100644 --- a/coverage/version.py +++ b/coverage/version.py @@ -5,7 +5,7 @@ # This file is exec'ed in setup.py, don't import anything! # Same semantics as sys.version_info. -version_info = (6, 0, 3, "alpha", 0) +version_info = (6, 1, 0, "alpha", 0) def _make_version(major, minor, micro, releaselevel, serial): diff --git a/doc/cmd.rst b/doc/cmd.rst index b4bf41ab3..1a54043d1 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -137,6 +137,10 @@ If your coverage results seem to be overlooking code that you know has been executed, try running coverage.py again with the ``--timid`` flag. This uses a simpler but slower trace method, and might be needed in rare cases. +Coverage.py sets an environment variable, ``COVERAGE_RUN`` to indicate that +your code is running under coverage measurement. The value is not relevant, +and may change in the future. + .. _cmd_warnings: diff --git a/tests/test_process.py b/tests/test_process.py index c9a2f8eea..29ce6071b 100644 --- a/tests/test_process.py +++ b/tests/test_process.py @@ -39,7 +39,7 @@ def test_save_on_exit(self): self.run_command("coverage run mycode.py") self.assert_exists(".coverage") - def test_environment(self): + def test_tests_dir_is_importable(self): # Checks that we can import modules from the tests directory at all! self.make_file("mycode.py", """\ import covmod1 @@ -53,6 +53,21 @@ def test_environment(self): self.assert_exists(".coverage") assert out == 'done\n' + def test_coverage_run_envvar_is_in_coveragerun(self): + # Test that we are setting COVERAGE_RUN when we run. + self.make_file("envornot.py", """\ + import os + print(os.environ.get("COVERAGE_RUN", "nope")) + """) + self.del_environ("COVERAGE_RUN") + # Regular Python doesn't have the environment variable. + out = self.run_command("python envornot.py") + assert out == "nope\n" + self.del_environ("COVERAGE_RUN") + # But `coverage run` does have it. + out = self.run_command("coverage run envornot.py") + assert out == "true\n" + def make_b_or_c_py(self): """Create b_or_c.py, used in a few of these tests.""" # "b_or_c.py b" will run 6 lines. From efde114f079cb0c0aad78e192843bf51e8951c61 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 16 Oct 2021 17:46:57 -0400 Subject: [PATCH 021/137] build: jQuery 3.6.0 --- CHANGES.rst | 5 ++++- coverage/htmlfiles/jquery.min.js | 6 ++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 95b34a774..3fabe4c86 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -34,7 +34,10 @@ Unreleased - Performance: Branch coverage measurement is faster, though you might only notice on code that is executed many times, such as long-running loops. - .. _issue 553: https://github.com/nedbat/coveragepy/issues/553 +- Build: jQuery is updated to 3.6.0 (`issue 840`_). + +.. _issue 553: https://github.com/nedbat/coveragepy/issues/553 +.. _issue 840: https://github.com/nedbat/coveragepy/issues/840 .. _changes_602: diff --git a/coverage/htmlfiles/jquery.min.js b/coverage/htmlfiles/jquery.min.js index d1608e37f..c4c6022f2 100644 --- a/coverage/htmlfiles/jquery.min.js +++ b/coverage/htmlfiles/jquery.min.js @@ -1,4 +1,2 @@ -/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ -!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; -if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,"",""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:k.htmlSerialize?[0,"",""]:[1,"X
","
"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("