Add the new config parameter for show_configs function and update the docs

Author: OlenaYefymenko

doc/cmd.rst

@@ -322,6 +322,12 @@ file:
         [run]
         disable_warnings = no-data-collected
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.run]
+        disable_warnings = ["no-data-collected"]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -334,7 +340,7 @@ file:
         [coverage:run]
         disable_warnings = no-data-collected
 
-.. [[[end]]] (sum: SJKFvPoXO2)
+.. [[[end]]] (sum: CZaDzmXkEi)
 
 
 .. _cmd_datafile:

doc/cog_helpers.py

@@ -75,7 +75,7 @@ def show_configs(ini, toml):
     The equivalence is checked for accuracy, and the process fails if there's
     a mismatch.
 
-    A three-tabbed box will be produced.
+    A four-tabbed box will be produced.
     """
     ini, ini_vals = _read_config(ini, "covrc")
     toml, toml_vals = _read_config(toml, "covrc.toml")
@@ -88,6 +88,7 @@ def show_configs(ini, toml):
     print(".. tabs::\n")
     for name, syntax, text in [
         (".coveragerc", "ini", ini),
+        (".coveragerc.toml", "toml", toml),
         ("pyproject.toml", "toml", toml),
         ("setup.cfg or tox.ini", "ini", ini2),
     ]:

doc/config.rst

@@ -138,34 +138,6 @@ Here's a sample configuration file, in each syntax:
             directory = coverage_html_report
             """,
 
-        coveragerc_toml=r"""
-            [tool.coverage.run]
-            branch = true
-
-            [tool.coverage.report]
-            # Regexes for lines to exclude from consideration
-            exclude_also = [
-                # Don't complain about missing debug-only code:
-                "def __repr__",
-                "if self\\.debug",
-
-                # Don't complain if tests don't hit defensive assertion code:
-                "raise AssertionError",
-                "raise NotImplementedError",
-
-                # Don't complain if non-runnable code isn't run:
-                "if 0:",
-                "if __name__ == .__main__.:",
-
-                # Don't complain about abstract methods, they aren't run:
-                "@(abc\\.)?abstractmethod",
-                ]
-
-            ignore_errors = true
-
-            [tool.coverage.html]
-            directory = "coverage_html_report"
-            """,
         toml=r"""
             [tool.coverage.run]
             branch = true
@@ -317,7 +289,7 @@ Here's a sample configuration file, in each syntax:
         [coverage:html]
         directory = coverage_html_report
 
-.. [[[end]]] (sum: HU1Z62mvRK)
+.. [[[end]]] (sum: EQ1Fn4BHJk)
 
 
 The specific configuration settings are described below.  Many sections and
@@ -636,6 +608,16 @@ equivalent when combining data from different machines:
             /jenkins/build/*/src
             c:\myproj\src
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.paths]
+        source = [
+            "src/",
+            "/jenkins/build/*/src",
+            "c:\\myproj\\src",
+            ]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -655,7 +637,7 @@ equivalent when combining data from different machines:
             /jenkins/build/*/src
             c:\myproj\src
 
-.. [[[end]]] (sum: oHSl8SGiMT)
+.. [[[end]]] (sum: QLgJoxGH3G)
 
 
 The names of the entries ("source" in this example) are ignored, you may choose

doc/contexts.rst

@@ -96,6 +96,12 @@ The ``[run] dynamic_context`` setting has only one option now.  Set it to
         [run]
         dynamic_context = test_function
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.run]
+        dynamic_context = "test_function"
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -108,7 +114,7 @@ The ``[run] dynamic_context`` setting has only one option now.  Set it to
         [coverage:run]
         dynamic_context = test_function
 
-.. [[[end]]] (sum: dZTDYjHw71)
+.. [[[end]]] (sum: oHx7GVdhqU)
 
 Each test function you run will be considered a separate dynamic context, and
 coverage data will be segregated for each.  A test function is any function

doc/excluding.rst

@@ -143,6 +143,14 @@ all of them by adding a regex to the exclusion list:
         exclude_also =
             def __repr__
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.report]
+        exclude_also = [
+            "def __repr__",
+        ]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -158,7 +166,7 @@ all of them by adding a regex to the exclusion list:
         exclude_also =
             def __repr__
 
-.. [[[end]]] (sum: 8+cOvxKPvv)
+.. [[[end]]] (sum: 4lYsdpcbf/)
 
 For example, here's a list of exclusions I've used:
 
@@ -214,6 +222,23 @@ For example, here's a list of exclusions I've used:
             class .*\bProtocol\):
             @(abc\.)?abstractmethod
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.report]
+        exclude_also = [
+            'def __repr__',
+            'if self.debug:',
+            'if settings.DEBUG',
+            'raise AssertionError',
+            'raise NotImplementedError',
+            'if 0:',
+            'if __name__ == .__main__.:',
+            'if TYPE_CHECKING:',
+            'class .*\bProtocol\):',
+            '@(abc\.)?abstractmethod',
+        ]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -247,7 +272,7 @@ For example, here's a list of exclusions I've used:
             class .*\bProtocol\):
             @(abc\.)?abstractmethod
 
-.. [[[end]]] (sum: ZQsgnt0nES)
+.. [[[end]]] (sum: +D/FLd6oVC)
 
 The :ref:`config_report_exclude_also` option adds regexes to the built-in
 default list so that you can add your own exclusions.  The older
@@ -317,6 +342,19 @@ Here are some examples:
             ; 3. A pragma comment that excludes an entire file:
             \A(?s:.*# pragma: exclude file.*)\Z
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.report]
+        exclude_also = [
+            # 1. Exclude an except clause of a specific form:
+            'except ValueError:\n\s*assume\(False\)',
+            # 2. Comments to turn coverage on and off:
+            'no cover: start(?s:.)*?no cover: stop',
+            # 3. A pragma comment that excludes an entire file:
+            '\A(?s:.*# pragma: exclude file.*)\Z',
+        ]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -342,7 +380,7 @@ Here are some examples:
             ; 3. A pragma comment that excludes an entire file:
             \A(?s:.*# pragma: exclude file.*)\Z
 
-.. [[[end]]] (sum: xG6Bmtmh06)
+.. [[[end]]] (sum: eg9c8WbMqW)
 
 The first regex matches a specific except line followed by a specific function
 call.  Both lines must be present for the exclusion to take effect. Note that

doc/plugins.rst

@@ -71,6 +71,12 @@ a coverage.py plug-in called ``something.plugin``.
            plugins =
                something.plugin
 
+       .. code-tab:: toml
+           :caption: .coveragerc.toml
+
+           [tool.coverage.run]
+           plugins = [ "something.plugin" ]
+
        .. code-tab:: toml
            :caption: pyproject.toml
 
@@ -84,7 +90,7 @@ a coverage.py plug-in called ``something.plugin``.
            plugins =
                something.plugin
 
-   .. [[[end]]] (sum: boZjI9S8MZ)
+   .. [[[end]]] (sum: +V9pwwXF47)
 
 #. If the plug-in needs its own configuration, you can add those settings in
    the .coveragerc file in a section named for the plug-in:
@@ -113,6 +119,13 @@ a coverage.py plug-in called ``something.plugin``.
            option1 = True
            option2 = abc.foo
 
+       .. code-tab:: toml
+           :caption: .coveragerc.toml
+
+           [tool.coverage.something.plugin]
+           option1 = true
+           option2 = "abc.foo"
+
        .. code-tab:: toml
            :caption: pyproject.toml
 
@@ -127,7 +140,7 @@ a coverage.py plug-in called ``something.plugin``.
            option1 = True
            option2 = abc.foo
 
-   .. [[[end]]] (sum: tpARXb5/bH)
+   .. [[[end]]] (sum: woHFW9mOUC)
 
    Check the documentation for the plug-in for details on the options it takes.
 

doc/source.rst

@@ -114,6 +114,19 @@ current directory:
             # omit this single file
             utils/tirefire.py
 
+    .. code-tab:: toml
+        :caption: .coveragerc.toml
+
+        [tool.coverage.run]
+        omit = [
+            # omit anything in a .local directory anywhere
+            "*/.local/*",
+            # omit everything in /usr
+            "/usr/*",
+            # omit this single file
+            "utils/tirefire.py",
+            ]
+
     .. code-tab:: toml
         :caption: pyproject.toml
 
@@ -139,7 +152,7 @@ current directory:
             # omit this single file
             utils/tirefire.py
 
-.. [[[end]]] (sum: hK0nQ8wMeg)
+.. [[[end]]] (sum: lKoRbHzA05)
 
 The ``source``, ``include``, and ``omit`` values all work together to determine
 the source that will be measured.