fix: some file path settings didn't do tilde expansion

Author: nedbat

CHANGES.rst

@@ -39,6 +39,11 @@ Unreleased
   ":ref:`config_report_exclude_also`" setting for adding line exclusion
   patterns.
 
+- A few file path configuration settings didn't allow for tilde expansion:
+  :ref:`config_json_output`, :ref:`config_lcov_output` and
+  :ref:`config_run_debug_file`.  This is now fixed.
+
+
 .. _issue 310: https://github.com/nedbat/coveragepy/issues/310
 .. _issue 312: https://github.com/nedbat/coveragepy/issues/312
 .. _issue 831: https://github.com/nedbat/coveragepy/issues/831

coverage/config.py

@@ -104,6 +104,11 @@ def get(self, section: str, option: str, *args: Any, **kwargs: Any) -> str: # ty
         v = substitute_variables(v, os.environ)
         return v
 
+    def getfile(self, section: str, option: str) -> str:
+        """Fix up a file path setting."""
+        path = self.get(section, option)
+        return process_file_value(path)
+
     def getlist(self, section: str, option: str) -> list[str]:
         """Read a list of strings.
 
@@ -376,9 +381,9 @@ def copy(self) -> CoverageConfig:
         ("context", "run:context"),
         ("core", "run:core"),
         ("cover_pylib", "run:cover_pylib", "boolean"),
-        ("data_file", "run:data_file"),
+        ("data_file", "run:data_file", "file"),
         ("debug", "run:debug", "list"),
-        ("debug_file", "run:debug_file"),
+        ("debug_file", "run:debug_file", "file"),
         ("disable_warnings", "run:disable_warnings", "list"),
         ("dynamic_context", "run:dynamic_context"),
         ("parallel", "run:parallel", "boolean"),
@@ -415,23 +420,23 @@ def copy(self) -> CoverageConfig:
 
         # [html]
         ("extra_css", "html:extra_css"),
-        ("html_dir", "html:directory"),
+        ("html_dir", "html:directory", "file"),
         ("html_skip_covered", "html:skip_covered", "boolean"),
         ("html_skip_empty", "html:skip_empty", "boolean"),
         ("html_title", "html:title"),
         ("show_contexts", "html:show_contexts", "boolean"),
 
         # [xml]
-        ("xml_output", "xml:output"),
+        ("xml_output", "xml:output", "file"),
         ("xml_package_depth", "xml:package_depth", "int"),
 
         # [json]
-        ("json_output", "json:output"),
+        ("json_output", "json:output", "file"),
         ("json_pretty_print", "json:pretty_print", "boolean"),
         ("json_show_contexts", "json:show_contexts", "boolean"),
 
         # [lcov]
-        ("lcov_output", "lcov:output"),
+        ("lcov_output", "lcov:output", "file"),
         ("lcov_line_checksums", "lcov:line_checksums", "boolean")
     ]
 
@@ -523,17 +528,10 @@ def get_option(self, option_name: str) -> TConfigValueOut | None:
         # If we get here, we didn't find the option.
         raise ConfigError(f"No such option: {option_name!r}")
 
-    def post_process_file(self, path: str) -> str:
-        """Make final adjustments to a file path to make it usable."""
-        return os.path.expanduser(path)
-
     def post_process(self) -> None:
         """Make final adjustments to settings to make them usable."""
-        self.data_file = self.post_process_file(self.data_file)
-        self.html_dir = self.post_process_file(self.html_dir)
-        self.xml_output = self.post_process_file(self.xml_output)
         self.paths = {
-            k: [self.post_process_file(f) for f in v]
+            k: [process_file_value(f) for f in v]
             for k, v in self.paths.items()
         }
         self.exclude_list += self.exclude_also
@@ -546,6 +544,11 @@ def debug_info(self) -> list[tuple[str, Any]]:
         )
 
 
+def process_file_value(path: str) -> str:
+    """Make adjustments to a file path to make it usable."""
+    return os.path.expanduser(path)
+
+
 def process_regexlist(name: str, option: str, values: list[str]) -> list[str]:
     """Check the values in a regex list and keep the non-blank ones."""
     value_list = []

coverage/tomlconfig.py

@@ -178,6 +178,10 @@ def getboolean(self, section: str, option: str) -> bool:
         bool_strings = {"true": True, "false": False}
         return self._check_type(name, option, value, bool, bool_strings.__getitem__, "a boolean")
 
+    def getfile(self, section: str, option: str) -> str:
+        _, value = self._get_single(section, option)
+        return config.process_file_value(value)
+
     def _get_list(self, section: str, option: str) -> tuple[str, list[str]]:
         """Get a list of strings, substituting environment variables in the elements."""
         name, values = self._get(section, option)

tests/test_config.py

@@ -307,6 +307,12 @@ def test_tilde_in_config(self) -> None:
             [html]
             directory = ~joe/html_dir
 
+            [json]
+            output = ~/json/output.json
+
+            [lcov]
+            output = ~/lcov/~foo.lcov
+
             [xml]
             output = ~/somewhere/xml.out
 
@@ -321,23 +327,8 @@ def test_tilde_in_config(self) -> None:
                 ~/src
                 ~joe/source
             """)
-        def expanduser(s: str) -> str:
-            """Fake tilde expansion"""
-            s = s.replace("~/", "/Users/me/")
-            s = s.replace("~joe/", "/Users/joe/")
-            return s
 
-        with mock.patch.object(
-            coverage.config.os.path,  # type: ignore[attr-defined]
-            'expanduser',
-            new=expanduser
-        ):
-            cov = coverage.Coverage()
-        assert cov.config.data_file == "/Users/me/data.file"
-        assert cov.config.html_dir == "/Users/joe/html_dir"
-        assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
-        assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
-        assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']}
+        self.assert_tilde_results()
 
     def test_tilde_in_toml_config(self) -> None:
         # Config entries that are file paths can be tilde-expanded.
@@ -348,6 +339,12 @@ def test_tilde_in_toml_config(self) -> None:
             [tool.coverage.html]
             directory = "~joe/html_dir"
 
+            [tool.coverage.json]
+            output = "~/json/output.json"
+
+            [tool.coverage.lcov]
+            output = "~/lcov/~foo.lcov"
+
             [tool.coverage.xml]
             output = "~/somewhere/xml.out"
 
@@ -364,20 +361,27 @@ def test_tilde_in_toml_config(self) -> None:
                 "~joe/source",
             ]
             """)
+
+        self.assert_tilde_results()
+
+    def assert_tilde_results(self) -> None:
+        """Common assertions for two tilde tests."""
         def expanduser(s: str) -> str:
             """Fake tilde expansion"""
             s = s.replace("~/", "/Users/me/")
             s = s.replace("~joe/", "/Users/joe/")
             return s
 
         with mock.patch.object(
-            coverage.config.os.path, # type: ignore[attr-defined]
+            coverage.config.os.path,  # type: ignore[attr-defined]
             'expanduser',
             new=expanduser
         ):
             cov = coverage.Coverage()
         assert cov.config.data_file == "/Users/me/data.file"
         assert cov.config.html_dir == "/Users/joe/html_dir"
+        assert cov.config.json_output == "/Users/me/json/output.json"
+        assert cov.config.lcov_output == "/Users/me/lcov/~foo.lcov"
         assert cov.config.xml_output == "/Users/me/somewhere/xml.out"
         assert cov.config.exclude_list == ["~/data.file", "~joe/html_dir"]
         assert cov.config.paths == {'mapping': ['/Users/me/src', '/Users/joe/source']}