Support report terminal output in Markdown Table format #1418 #1479

stepeos · 2022-10-23T21:34:52Z

$ tox -e py37
py37 develop-inst-noop: foo/bar/coveragepy
py37 installed: atomicwrites==1.4.1,attrs==22.1.0,backports.functools-lru-cache==1.6.4,cffi==1.15.1,colorama==0.4.5,-e git+ssh://git@github.com/stepeos/coveragepy.git@b3179db61fcf593fa41ce3f862f0af39d3383f7a#egg=coverage,decorator==5.1.1,distlib==0.3.6,dnspython==2.2.1,eventlet==0.33.1,exceptiongroup==1.0.0rc9,execnet==1.9.0,filelock==3.8.0,flaky==3.7.0,future==0.18.2,gevent==21.12.0,greenlet==1.1.3,hypothesis==6.54.6,importlib-metadata==4.12.0,iniconfig==1.1.1,packaging==21.3,platformdirs==2.5.2,pluggy==1.0.0,py==1.11.0,PyContracts @ https://github.com/slorg1/contracts/archive/c5a6da27d4dc9985f68e574d20d86000880919c3.zip,pycparser==2.21,pyparsing==3.0.9,pytest==7.1.3,pytest-forked==1.4.0,pytest-xdist==2.5.0,qualname==0.1.0,six==1.16.0,sortedcontainers==2.4.0,tomli==2.0.1,typing_extensions==4.3.0,virtualenv==20.16.5,zipp==3.8.1,zope.event==4.5.0,zope.interface==5.4.0
py37 run-test-pre: PYTHONHASHSEED='1893709823'
py37 run-test: commands[0] | python igor.py zip_mods
py37 run-test: commands[1] | python setup.py --quiet build_ext --inplace
py37 run-test: commands[2] | python -m pip install -q -e .
WARNING: You are using pip version 22.0.4; however, version 22.3 is available.
You should consider upgrading via the 'foo/bar/coveragepy/.tox/py37/bin/python -m pip install --upgrade pip' command.
py37 run-test: commands[3] | python igor.py test_with_tracer c
=== CPython 3.7.13 with C tracer (.tox/py37/bin/python) ===
bringing up nodes...
.............................................................................................................................x.x.......................ss.s........... [ 13%]
.................................................................................................................................................................... [ 27%]
.................................................................................................................................................................... [ 41%]
...................................................................................................................................................................... [ 55%]
.s.........s....................................................................................................................................s...............s... [ 69%]
.............s........................................................s.........................................................................s.................... [ 83%]
............................................................s....................................................................................................... [ 97%]
............................                                                                                                                                         [100%]
1168 passed, 11 skipped, 2 xfailed in 98.02s (0:01:38)
py37 run-test: commands[4] | python igor.py remove_extension
py37 run-test: commands[5] | python igor.py test_with_tracer py
=== CPython 3.7.13 with Python tracer (.tox/py37/bin/python) ===
bringing up nodes...
...........................................................................................................................x..x.........................ss..s....... [ 13%]
.........................................................................................................ssssss.s......s...ss....................................... [ 27%]
.................................................................................................................................................................... [ 41%]
.................................................................................................................................................................... [ 55%]
......s........s.............................................................................................................................s..............s....... [ 69%]
.s............s..............................sssssssssssssssssssss...........s..............s....................................................................... [ 83%]
........s.........................................................s................................................................................................. [ 97%]
...........................ss....                                                                                                                                    [100%]
1133 passed, 46 skipped, 2 xfailed in 88.22s (0:01:28)
_________________________________________________________________________________ summary __________________________________________________________________________________
  py37: commands succeeded
  congratulations :)

nedbat · 2022-10-24T09:56:46Z

Thanks for taking this on. I have some concerns with the code as it stands now, but you'll have to tell me how long you want to continue working on this, or whether I should take it over at some point.

(easy) The option should be --format, not --format-text.
(real work) There's too much code duplicated between the two formatting methods. The original code mixed together the logic of the table (sorting, how many columns, which lines to include) with the formatting of the table, which was not great. This pull request now duplicates the logic parts between _report_text and _report_markdown, which is a real problem. Better would be to have one function that pulls together the data and gets it ready for formatting, then uses either a text or markdown formatting function. Someone someday is going to ask for another format, and I would hate to see the logic duplicated a third time.
(not too bad) How to test these things is always tricky. Once step 2 is done, we can use unit testing of the formatting function to avoid having to add too much duplication in the test methods. A few cases like you've done it would probably be enough.
(easy) The quality jobs will pass if you run make prebuild locally to fix up some of the computed content in the docs.

Let me know how I can help with any of these.

stepeos · 2022-10-24T10:21:52Z

option should be --format, not --format-text

I implemented the cmdline argument as --format, but the variable is called format_text since format is also a builtin python method. format was linted on my editor as function. Still change?

2. have one function that pulls together the data and gets it ready for formatting

this was my idea as well, and I tried implementing it that way. _report_text takes the data and the command line options and builds the format string and inserts the values.
The major 'logic' part that i can see is duplicated is the sorting of the lines.
I'd love to give it one more try if you tell me which data should be input to _report_markdown and _report_text, and what exact parts should be moved to report()

nedbat · 2022-10-25T11:53:12Z

option should be --format, not --format-text

I implemented the cmdline argument as --format, but the variable is called format_text since format is also a builtin python method. format was linted on my editor as function. Still change?

You can do something like this:

  output_format = optparse.make_option(
        '', '--format', action='store', metavar="FORMAT", dest="output_format",
        help="Output format, either text (default) or markdown",
    )

and it will put the option into an argument called output_format.

have one function that pulls together the data and gets it ready for formatting

this was my idea as well, and I tried implementing it that way. _report_text takes the data and the command line options and builds the format string and inserts the values. The major 'logic' part that i can see is duplicated is the sorting of the lines. I'd love to give it one more try if you tell me which data should be input to _report_markdown and _report_text, and what exact parts should be moved to report()

I haven't looked closely at the code to see exactly how this would work out, but the logic includes sorting of lines, what columns to include, whether to include a total line, and so on. I imagine one function producing a list of tuples: each list element is one row, the tuples are the cells for each column in that row. The header and total lines could be the first and last elements in the list, or it might work out better to pass them separately, I'm not sure.

stepeos · 2022-10-25T20:14:02Z

@nedbat thanks for you patience & suggestions, I really appreciate it (I'm learning a lot).

I have refactored summary.py. I moved all logic to the top level method report().
Data for Header, lines, TOTAL line and summary-lines ("x files skipped") is generated in the report and passed to either markdown- or text-formatted report-methods.

make prebuild did not fix the docs error unfortunately :/

nedbat · 2022-10-30T21:34:02Z

Thanks, I'll take a look very soon.

For the docs error, you have to go to the action, and find the failing line, which can be tricky, because you have to keep opening sections until you find it:

/home/runner/work/coveragepy/coveragepy/coverage/control.py:
docstring of coverage.control.Coverage.__init__:19:
Unknown directive type "veresionadded".

nedbat

Thanks for pushing forward on this. Let me know if I'm getting too picky, or if it's too much.

nedbat · 2022-10-30T21:39:31Z

coverage/summary.py

+
+        for end_line in end_lines:
+            self.writeout(end_line)
+        return self.total.n_statements and self.total.pc_covered


You don't need to return this from here, or from _report_markdown.

nedbat · 2022-10-30T21:40:50Z

coverage/summary.py

+        column_order = dict(name=0, stmts=1, miss=2, cover=-1)
+        if self.branches:
+            column_order.update(dict(branch=3, brpart=4))


column_order isn't used in this function (or in _report_markdown), so these lines can be deleted.

nedbat · 2022-10-30T21:45:08Z

coverage/summary.py

+    def _report_text(self, header, lines_values, total_line, end_lines):
+        "internal method to print report data in text format"
+        # Prepare the formatting strings, header, and column sorting.
+        max_name = max([len(fr.relative_filename()) for (fr, analysis) in \


You don't need a backslash to continue a line if you are in unbalanced brackets (as you are here). Also, I prefer to have the closing bracket on a line of its own. Take a look through other code in the repo to get a sense of the style.

nedbat · 2022-10-30T21:45:41Z

coverage/summary.py

@@ -30,6 +30,112 @@ def writeout(self, line):
        self.outfile.write(line.rstrip())
        self.outfile.write("\n")

+    def _report_text(self, header, lines_values, total_line, end_lines):
+        "internal method to print report data in text format"


Docstrings should always use triple-quote style, and complete English grammar.

nedbat · 2022-10-30T21:51:35Z

coverage/summary.py

-            if position is None:
-                raise ConfigError(f"Invalid sorting option: {self.config.sort!r}")
-            lines.sort(key=lambda l: (l[1][position], l[0]), reverse=reverse)
+            lines_values.sort(key=lambda tup: (tup[sort_idx], tup[0]),


I use a line-length of 100, so no need to wrap this line, and probably others in this file.

nedbat · 2022-10-30T22:06:06Z

coverage/summary.py

+        # Prepare the formatting strings, header, and column sorting.
+        max_name = max([len(fr.relative_filename()) for (fr, analysis) in \
+            self.fr_analysis] + [5]) + 2
+        n = self.config.precision


It seems odd to me to be looking at config.precision here, since you are getting all of the coverage totals as strings. You shouldn't need to think about the precision, just deal with the strings as they are, sort of how max_name is calculated.

nedbat · 2022-10-30T22:08:25Z

tests/test_api.py

+            ----------------------------
+            b.py         1      0   100%
+            ----------------------------
+            TOTAL        1      0   100%


Why did this change by one space?

nedbat · 2022-10-30T22:09:14Z

tests/test_api.py

+        print(report)
+        # cov.report(["no_biggie.py"], show_missing=True)


This looks like debugging left in the file?

nedbat · 2022-10-30T22:10:03Z

tests/test_plugins.py

+        # TOTAL            11      7      0      0    36%
+        assert report.split("\n")[2] == \
+            "bar_4.html        4      2      0      0    50% 1, 4"
+        total = int(report.split("\n")[-2].split(" ")[-1][:-1])


Why change the way the total is accessed by the test?

I'll remove most of them and test the few cases that are necessary.

nedbat · 2022-10-30T22:11:50Z

tests/test_summary.py

@@ -317,6 +423,22 @@ def not_covered():
        assert squeezed[6] == "1 file skipped due to complete coverage."
        assert self.last_command_status == 0

+        report = self.report_from_command(


I'm torn about adding all these markdown outputs to the tests. Is there a way we can test _report_text and _report_markdown more directly to reduce the overhead?

nedbat · 2022-10-30T22:22:31Z

coverage/summary.py

+        # Write the TOTAL line
+        if total_line:
+            total_form = dict(
+                Name="| {:>{name_len}}** |", Stmts="{:>5}** |", Miss="{:>5}** |",


I don't understand why the trailing stars are in the format string, but the leading stars are in the values on line 131?

It was just to less code. If I inserted the stars like
"**" + str(value) + "**"
then without special if else case, the Cover entry would look like:
****
On the other hand, I already had to make an if else statement for the missing column, so I'll rewrite it.

nedbat · 2022-10-30T22:23:18Z

coverage/summary.py

+            self.writeout(text)
+
+        # Write the TOTAL line
+        if total_line:


I ran a coverage report locally, and this line (and the similar one in _report_text) say the condition is always true. Is it true that these functions can never be called with an empty total_line, or do we just not have a test for that case?

The total line is always printed, if there is coverage data to report.

The report method raises an Exception before creating the total line, if there is no coverage data to report.

nedbat · 2022-11-02T10:20:23Z

@stepeos this is coming along nicely!

I notice now that coverage report --precision=3 (or other values) can make "100.000%" in the Cover column jam into the previous column with no space between them. I'm a little lost in the logic about why that is. Also, I thought I would have had a test to check that it didn't happen, but I guess I don't?
I still have formatting tweaks I'd like to make. I can make a pull request into your branch to do them if you like, or are you still working on that?

nedbat · 2022-11-02T10:30:56Z

Hmm, there is a test that shows precision is fine, so I'm not sure what the difference is with my local running.... I'm still digging into it.

nedbat · 2022-11-02T11:02:49Z

OK, I worked out the conditions for the poor formatting, and added a test in https://github.com/stepeos/coveragepy/pull/1.

nedbat · 2022-11-02T11:04:57Z

I can also commit that new test to master, and you rebase on top of it, since it looks like you'll need to do that soon anyway. Your choice.

test: add another test of correct report formatting

stepeos · 2022-11-02T11:10:17Z

Sounds great!
I added you to the repo.

nedbat · 2022-11-02T11:21:37Z

Sorry, I meant I could add the test to my master branch, and you would rebase your pull request on top of it. But you've already merged the pull request, so never mind :)

stepeos · 2022-11-02T14:25:04Z

To fix that, we'd have to get the max length of all lines for every column , I reckon.
It'd be easier to increase the width of the coverage column, but you want to keep it like it was before, right?

nedbat · 2022-11-04T10:05:07Z

I've made a styling update pull request: https://github.com/stepeos/coveragepy/pull/2

style: adjust the formatting

nedbat · 2022-11-05T16:27:28Z

Thanks again for doing all this. I'll squash and merge it now. If you have more you want to do to it, we can start another pull request.

nedbat · 2022-11-05T16:33:19Z

BTW, how should I credit you in the changelog? I don't know your name :)

stepeos · 2022-11-05T16:41:05Z

I'm Steve Oswald! And thanks :^)

…

On Sat, Nov 5, 2022, 17:33 Ned Batchelder ***@***.***> wrote: BTW, how should I credit you in the changelog? I don't know your name :) — Reply to this email directly, view it on GitHub <#1479 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ATW7LIAJI6CRM4FNTOVSWE3WG2D5TANCNFSM6AAAAAARMOUHME> . You are receiving this because you were mentioned.Message ID: ***@***.***>

nedbat · 2022-12-03T18:21:28Z

This is now released as part of coverage 7.0.0b1.

Version 7.2.5 — 2023-04-30 -------------------------- - Fix: ``html_report()`` could fail with an AttributeError on ``isatty`` if run in an unusual environment where sys.stdout had been replaced. This is now fixed. Version 7.2.4 — 2023-04-28 -------------------------- PyCon 2023 sprint fixes! - Fix: with ``relative_files = true``, specifying a specific file to include or omit wouldn't work correctly (`issue 1604`_). This is now fixed, with testing help by `Marc Gibbons <pull 1608_>`_. - Fix: the XML report would have an incorrect ``<source>`` element when using relative files and the source option ended with a slash (`issue 1541`_). This is now fixed, thanks to `Kevin Brown-Silva <pull 1608_>`_. - When the HTML report location is printed to the terminal, it's now a terminal-compatible URL, so that you can click the location to open the HTML file in your browser. Finishes `issue 1523`_ thanks to `Ricardo Newbery <pull 1613_>`_. - Docs: a new :ref:`Migrating page <migrating>` with details about how to migrate between major versions of coverage.py. It currently covers the wildcard changes in 7.x. Thanks, `Brian Grohe <pull 1610_>`_. .. _issue 1523: nedbat/coveragepy#1523 .. _issue 1541: nedbat/coveragepy#1541 .. _issue 1604: nedbat/coveragepy#1604 .. _pull 1608: nedbat/coveragepy#1608 .. _pull 1609: nedbat/coveragepy#1609 .. _pull 1610: nedbat/coveragepy#1610 .. _pull 1613: nedbat/coveragepy#1613 Version 7.2.3 — 2023-04-06 -------------------------- - Fix: the :ref:`config_run_sigterm` setting was meant to capture data if a process was terminated with a SIGTERM signal, but it didn't always. This was fixed thanks to `Lewis Gaul <pull 1600_>`_, closing `issue 1599`_. - Performance: HTML reports with context information are now much more compact. File sizes are typically as small as one-third the previous size, but can be dramatically smaller. This closes `issue 1584`_ thanks to `Oleh Krehel <pull 1587_>`_. - Development dependencies no longer use hashed pins, closing `issue 1592`_. .. _issue 1584: nedbat/coveragepy#1584 .. _pull 1587: nedbat/coveragepy#1587 .. _issue 1592: nedbat/coveragepy#1592 .. _issue 1599: nedbat/coveragepy#1599 .. _pull 1600: nedbat/coveragepy#1600 Version 7.2.2 — 2023-03-16 -------------------------- - Fix: if a virtualenv was created inside a source directory, and a sourced package was installed inside the virtualenv, then all of the third-party packages inside the virtualenv would be measured. This was incorrect, but has now been fixed: only the specified packages will be measured, thanks to `Manuel Jacob <pull 1560_>`_. - Fix: the ``coverage lcov`` command could create a .lcov file with incorrect LF (lines found) and LH (lines hit) totals. This is now fixed, thanks to `Ian Moore <pull 1583_>`_. - Fix: the ``coverage xml`` command on Windows could create a .xml file with duplicate ``<package>`` elements. This is now fixed, thanks to `Benjamin Parzella <pull 1574_>`_, closing `issue 1573`_. .. _pull 1560: nedbat/coveragepy#1560 .. _issue 1573: nedbat/coveragepy#1573 .. _pull 1574: nedbat/coveragepy#1574 .. _pull 1583: nedbat/coveragepy#1583 Version 7.2.1 — 2023-02-26 -------------------------- - Fix: the PyPI page had broken links to documentation pages, but no longer does, closing `issue 1566`_. - Fix: public members of the coverage module are now properly indicated so that mypy will find them, fixing `issue 1564`_. .. _issue 1564: nedbat/coveragepy#1564 .. _issue 1566: nedbat/coveragepy#1566 Version 7.2.0 — 2023-02-22 -------------------------- - Added a new setting ``[report] exclude_also`` to let you add more exclusions without overwriting the defaults. Thanks, `Alpha Chen <pull 1557_>`_, closing `issue 1391`_. - Added a :meth:`.CoverageData.purge_files` method to remove recorded data for a particular file. Contributed by `Stephan Deibel <pull 1547_>`_. - Fix: when reporting commands fail, they will no longer congratulate themselves with messages like "Wrote XML report to file.xml" before spewing a traceback about their failure. - Fix: arguments in the public API that name file paths now accept pathlib.Path objects. This includes the ``data_file`` and ``config_file`` arguments to the Coverage constructor and the ``basename`` argument to CoverageData. Closes `issue 1552`_. - Fix: In some embedded environments, an IndexError could occur on stop() when the originating thread exits before completion. This is now fixed, thanks to `Russell Keith-Magee <pull 1543_>`_, closing `issue 1542`_. - Added a ``py.typed`` file to announce our type-hintedness. Thanks, `KotlinIsland <pull 1550_>`_. .. _issue 1391: nedbat/coveragepy#1391 .. _issue 1542: nedbat/coveragepy#1542 .. _pull 1543: nedbat/coveragepy#1543 .. _pull 1547: nedbat/coveragepy#1547 .. _pull 1550: nedbat/coveragepy#1550 .. _issue 1552: nedbat/coveragepy#1552 .. _pull 1557: nedbat/coveragepy#1557 Version 7.1.0 — 2023-01-24 -------------------------- - Added: the debug output file can now be specified with ``[run] debug_file`` in the configuration file. Closes `issue 1319`_. - Performance: fixed a slowdown with dynamic contexts that's been around since 6.4.3. The fix closes `issue 1538`_. Thankfully this doesn't break the `Cython change`_ that fixed `issue 972`_. Thanks to Mathieu Kniewallner for the deep investigative work and comprehensive issue report. - Typing: all product and test code has type annotations. .. _Cython change: nedbat/coveragepy#1347 .. _issue 972: nedbat/coveragepy#972 .. _issue 1319: nedbat/coveragepy#1319 .. _issue 1538: nedbat/coveragepy#1538 Version 7.0.5 — 2023-01-10 -------------------------- - Fix: On Python 3.7, a file with type annotations but no ``from __future__ import annotations`` would be missing statements in the coverage report. This is now fixed, closing `issue 1524`_. .. _issue 1524: nedbat/coveragepy#1524 Version 7.0.4 — 2023-01-07 -------------------------- - Performance: an internal cache of file names was accidentally disabled, resulting in sometimes drastic reductions in performance. This is now fixed, closing `issue 1527`_. Thanks to Ivan Ciuvalschii for the reproducible test case. .. _issue 1527: nedbat/coveragepy#1527 Version 7.0.3 — 2023-01-03 -------------------------- - Fix: when using pytest-cov or pytest-xdist, or perhaps both, the combining step could fail with ``assert row is not None`` using 7.0.2. This was due to a race condition that has always been possible and is still possible. In 7.0.1 and before, the error was silently swallowed by the combining code. Now it will produce a message "Couldn't combine data file" and ignore the data file as it used to do before 7.0.2. Closes `issue 1522`_. .. _issue 1522: nedbat/coveragepy#1522 Version 7.0.2 — 2023-01-02 -------------------------- - Fix: when using the ``[run] relative_files = True`` setting, a relative ``[paths]`` pattern was still being made absolute. This is now fixed, closing `issue 1519`_. - Fix: if Python doesn't provide tomllib, then TOML configuration files can only be read if coverage.py is installed with the ``[toml]`` extra. Coverage.py will raise an error if TOML support is not installed when it sees your settings are in a .toml file. But it didn't understand that ``[tools.coverage]`` was a valid section header, so the error wasn't reported if you used that header, and settings were silently ignored. This is now fixed, closing `issue 1516`_. - Fix: adjusted how decorators are traced on PyPy 7.3.10, fixing `issue 1515`_. - Fix: the ``coverage lcov`` report did not properly implement the ``--fail-under=MIN`` option. This has been fixed. - Refactor: added many type annotations, including a number of refactorings. This should not affect outward behavior, but they were a bit invasive in some places, so keep your eyes peeled for oddities. - Refactor: removed the vestigial and long untested support for Jython and IronPython. .. _issue 1515: nedbat/coveragepy#1515 .. _issue 1516: nedbat/coveragepy#1516 .. _issue 1519: nedbat/coveragepy#1519 Version 7.0.1 — 2022-12-23 -------------------------- - When checking if a file mapping resolved to a file that exists, we weren't considering files in .whl files. This is now fixed, closing `issue 1511`_. - File pattern rules were too strict, forbidding plus signs and curly braces in directory and file names. This is now fixed, closing `issue 1513`_. - Unusual Unicode or control characters in source files could prevent reporting. This is now fixed, closing `issue 1512`_. - The PyPy wheel now installs on PyPy 3.7, 3.8, and 3.9, closing `issue 1510`_. .. _issue 1510: nedbat/coveragepy#1510 .. _issue 1511: nedbat/coveragepy#1511 .. _issue 1512: nedbat/coveragepy#1512 .. _issue 1513: nedbat/coveragepy#1513 Version 7.0.0 — 2022-12-18 -------------------------- Nothing new beyond 7.0.0b1. Version 7.0.0b1 — 2022-12-03 ---------------------------- A number of changes have been made to file path handling, including pattern matching and path remapping with the ``[paths]`` setting (see :ref:`config_paths`). These changes might affect you, and require you to update your settings. (This release includes the changes from `6.6.0b1 <changes_6-6-0b1_>`_, since 6.6.0 was never released.) - Changes to file pattern matching, which might require updating your configuration: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing `issue 1407`_. - Now ``**`` matches any number of nested directories, including none. - Improvements to combining data files when using the :ref:`config_run_relative_files` setting, which might require updating your configuration: - During ``coverage combine``, relative file paths are implicitly combined without needing a ``[paths]`` configuration setting. This also fixed `issue 991`_. - A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that relative file paths can be combined more easily. - The :ref:`config_run_relative_files` setting is properly interpreted in more places, fixing `issue 1280`_. - When remapping file paths with ``[paths]``, a path will be remapped only if the resulting path exists. The documentation has long said the prefix had to exist, but it was never enforced. This fixes `issue 608`_, improves `issue 649`_, and closes `issue 757`_. - Reporting operations now implicitly use the ``[paths]`` setting to remap file paths within a single data file. Combining multiple files still requires the ``coverage combine`` step, but this simplifies some single-file situations. Closes `issue 1212`_ and `issue 713`_. - The ``coverage report`` command now has a ``--format=`` option. The original style is now ``--format=text``, and is the default. - Using ``--format=markdown`` will write the table in Markdown format, thanks to `Steve Oswald <pull 1479_>`_, closing `issue 1418`_. - Using ``--format=total`` will write a single total number to the output. This can be useful for making badges or writing status updates. - Combining data files with ``coverage combine`` now hashes the data files to skip files that add no new information. This can reduce the time needed. Many details affect the speed-up, but for coverage.py's own test suite, combining is about 40% faster. Closes `issue 1483`_. - When searching for completely un-executed files, coverage.py uses the presence of ``__init__.py`` files to determine which directories have source that could have been imported. However, `implicit namespace packages`_ don't require ``__init__.py``. A new setting ``[report] include_namespace_packages`` tells coverage.py to consider these directories during reporting. Thanks to `Felix Horvat <pull 1387_>`_ for the contribution. Closes `issue 1383`_ and `issue 1024`_. - Fixed environment variable expansion in pyproject.toml files. It was overly broad, causing errors outside of coverage.py settings, as described in `issue 1481`_ and `issue 1345`_. This is now fixed, but in rare cases will require changing your pyproject.toml to quote non-string values that use environment substitution. - An empty file has a coverage total of 100%, but used to fail with ``--fail-under``. This has been fixed, closing `issue 1470`_. - The text report table no longer writes out two separator lines if there are no files listed in the table. One is plenty. - Fixed a mis-measurement of a strange use of wildcard alternatives in match/case statements, closing `issue 1421`_. - Fixed internal logic that prevented coverage.py from running on implementations other than CPython or PyPy (`issue 1474`_). - The deprecated ``[run] note`` setting has been completely removed. .. _implicit namespace packages: https://peps.python.org/pep-0420/ .. _issue 608: nedbat/coveragepy#608 .. _issue 649: nedbat/coveragepy#649 .. _issue 713: nedbat/coveragepy#713 .. _issue 757: nedbat/coveragepy#757 .. _issue 991: nedbat/coveragepy#991 .. _issue 1024: nedbat/coveragepy#1024 .. _issue 1212: nedbat/coveragepy#1212 .. _issue 1280: nedbat/coveragepy#1280 .. _issue 1345: nedbat/coveragepy#1345 .. _issue 1383: nedbat/coveragepy#1383 .. _issue 1407: nedbat/coveragepy#1407 .. _issue 1418: nedbat/coveragepy#1418 .. _issue 1421: nedbat/coveragepy#1421 .. _issue 1470: nedbat/coveragepy#1470 .. _issue 1474: nedbat/coveragepy#1474 .. _issue 1481: nedbat/coveragepy#1481 .. _issue 1483: nedbat/coveragepy#1483 .. _pull 1387: nedbat/coveragepy#1387 .. _pull 1479: nedbat/coveragepy#1479 Version 6.6.0b1 — 2022-10-31 ---------------------------- (Note: 6.6.0 final was never released. These changes are part of `7.0.0b1 <changes_7-0-0b1_>`_.) - Changes to file pattern matching, which might require updating your configuration: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing `issue 1407`_. - Now ``**`` matches any number of nested directories, including none. - Improvements to combining data files when using the :ref:`config_run_relative_files` setting: - During ``coverage combine``, relative file paths are implicitly combined without needing a ``[paths]`` configuration setting. This also fixed `issue 991`_. - A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that relative file paths can be combined more easily. - The setting is properly interpreted in more places, fixing `issue 1280`_. - Fixed environment variable expansion in pyproject.toml files. It was overly broad, causing errors outside of coverage.py settings, as described in `issue 1481`_ and `issue 1345`_. This is now fixed, but in rare cases will require changing your pyproject.toml to quote non-string values that use environment substitution. - Fixed internal logic that prevented coverage.py from running on implementations other than CPython or PyPy (`issue 1474`_). .. _issue 991: nedbat/coveragepy#991 .. _issue 1280: nedbat/coveragepy#1280 .. _issue 1345: nedbat/coveragepy#1345 .. _issue 1407: nedbat/coveragepy#1407 .. _issue 1474: nedbat/coveragepy#1474 .. _issue 1481: nedbat/coveragepy#1481

These were lost in commit cf1efa8 commit cf1efa8 Author: stepeos <82703776+stepeos@users.noreply.github.com> Date: Sat Nov 5 17:29:04 2022 +0100 feat: report terminal output in Markdown Table format #1418 (#1479)

stepeos added 10 commits October 22, 2022 01:32

refactoring normal reporting text output

e050395

implemented markdown feature from #1418

3712391

minor changes

b222476

fixed text output

286dd66

fixed precision for text and markdown report format

8746883

minor changes

b41de9b

finished testing for markdown format feature

b3179db

fixed testing outside test_summary.py

3f3c6bc

removed fixed-length widespace padding for tests

488d886

removed whitespaces

28e690f

stepeos added 2 commits October 25, 2022 21:25

refactoring, fixing docs, rewriting cmd args

20edcfa

fixing code quality

ceef236

nedbat requested changes Oct 30, 2022

View reviewed changes

nedbat reviewed Oct 30, 2022

View reviewed changes

stepeos added 2 commits November 1, 2022 19:06

implementing requested changes

3017cb1

doc fix

52c8ae8

test: add another test of correct report formatting

9f2c978

Merge pull request #1 from nedbat/nedbat/add-test-to-1479

bb00948

test: add another test of correct report formatting

stepeos and others added 2 commits November 2, 2022 15:37

fixed precision printing test

1d43a83

Merge branch 'master' into master

d3cf237

nedbat and others added 3 commits November 4, 2022 06:58

style: adjust the formatting

87113b4

Merge pull request #2 from nedbat/nedbat/formatting-1479

3d366a1

style: adjust the formatting

Merge branch 'master' into master

c45e764

nedbat approved these changes Nov 5, 2022

View reviewed changes

nedbat merged commit cf1efa8 into nedbat:master Nov 5, 2022

nedbat mentioned this pull request Nov 5, 2022

Support report terminal output in Markdown Table format #1418

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support report terminal output in Markdown Table format #1418 #1479

Support report terminal output in Markdown Table format #1418 #1479

stepeos commented Oct 23, 2022

nedbat commented Oct 24, 2022

stepeos commented Oct 24, 2022

nedbat commented Oct 25, 2022

stepeos commented Oct 25, 2022 •

edited

Loading

nedbat commented Oct 30, 2022

nedbat left a comment

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

stepeos Nov 1, 2022

nedbat Oct 30, 2022

nedbat Oct 30, 2022

stepeos Oct 31, 2022

nedbat Oct 30, 2022

stepeos Nov 1, 2022

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

stepeos commented Nov 2, 2022

nedbat commented Nov 2, 2022 •

edited

Loading

stepeos commented Nov 2, 2022

nedbat commented Nov 4, 2022

nedbat commented Nov 5, 2022

nedbat commented Nov 5, 2022

stepeos commented Nov 5, 2022 via email

nedbat commented Dec 3, 2022

		print(report)
		# cov.report(["no_biggie.py"], show_missing=True)

Support report terminal output in Markdown Table format #1418 #1479

Support report terminal output in Markdown Table format #1418 #1479

Conversation

stepeos commented Oct 23, 2022

nedbat commented Oct 24, 2022

stepeos commented Oct 24, 2022

nedbat commented Oct 25, 2022

stepeos commented Oct 25, 2022 • edited Loading

nedbat commented Oct 30, 2022

nedbat left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

nedbat commented Nov 2, 2022

stepeos commented Nov 2, 2022

nedbat commented Nov 2, 2022 • edited Loading

stepeos commented Nov 2, 2022

nedbat commented Nov 4, 2022

nedbat commented Nov 5, 2022

nedbat commented Nov 5, 2022

stepeos commented Nov 5, 2022 via email

nedbat commented Dec 3, 2022

stepeos commented Oct 25, 2022 •

edited

Loading

nedbat commented Nov 2, 2022 •

edited

Loading