Suport # character in path of tox project

Signed-off-by: Bernát Gábor <[email protected]>

Author: gaborbernat

docs/changelog/763.bugfix.rst

@@ -0,0 +1 @@
+Support ``#`` character in path for the tox project - by :user:`gaborbernat`.

src/tox/config/loader/ini/__init__.py

@@ -29,16 +29,17 @@ def __init__(self, section: str, parser: ConfigParser, overrides: List[Override]
         super().__init__(overrides)
 
     def load_raw(self, key: str, conf: Optional["Config"], env_name: Optional[str]) -> str:
-        value = self._section[key]
+        return self.process_raw(conf, env_name, self._section[key])
 
+    @staticmethod
+    def process_raw(conf: Optional["Config"], env_name: Optional[str], value: str) -> str:
         # strip comments
         elements: List[str] = []
         for line in value.split("\n"):
             if not line.startswith("#"):
                 part = _COMMENTS.sub("", line)
                 elements.append(part.replace("\\#", "#"))
         strip_comments = "\n".join(elements)
-
         if conf is None:  # conf is None when we're loading the global tox configuration file for the CLI
             factor_filtered = strip_comments  # we don't support factor and replace functionality there
         else:

src/tox/config/loader/ini/replace.py

@@ -20,6 +20,7 @@
 
 # split alongside :, unless it's escaped, or it's preceded by a single capital letter (Windows drive letter in paths)
 ARGS_GROUP = re.compile(r"(?<!\\\\|:[A-Z]):")
+NOT_ESCAPED_COMMENT = re.compile(r"(?<!\\)#")
 
 
 def replace(conf: "Config", name: Optional[str], loader: "IniLoader", value: str, chain: List[str]) -> str:
@@ -120,9 +121,11 @@ def replace_reference(
             for src in _config_value_sources(settings["env"], settings["section"], current_env, conf, loader):
                 try:
                     if isinstance(src, SectionProxy):
-                        return src[key]
+                        return loader.process_raw(conf, current_env, src[key])
                     value = src.load(key, chain)
                     as_str, _ = stringify(value)
+                    # escape unescaped comment characters to preserve them during processing
+                    as_str = NOT_ESCAPED_COMMENT.sub("\\#", as_str)
                     return as_str
                 except KeyError as exc:  # if fails, keep trying maybe another source can satisfy
                     exception = exc

src/tox/config/set_env.py

@@ -41,6 +41,7 @@ def load(self, item: str, chain: Optional[List[str]] = None) -> str:
             return self._materialized[item]
         raw = self._raw[item]
         result = self.replacer(raw, chain)  # apply any replace options
+        result = result.replace(r"\#", "#")  # unroll escaped comment with replacement
         self._materialized[item] = result
         self._raw.pop(item, None)  # if the replace requires the env we may be called again, so allow pop to fail
         return result

src/tox/pytest.py

@@ -370,17 +370,19 @@ def matches(pattern: str, text: str, flags: int = 0) -> None:
 
 
 class ToxProjectCreator(Protocol):
-    def __call__(self, files: Dict[str, Any], base: Optional[Path] = None) -> ToxProject:  # noqa: U100
+    def __call__(
+        self, files: Dict[str, Any], base: Optional[Path] = None, prj_path: Optional[Path] = None  # noqa: U100
+    ) -> ToxProject:
         ...
 
 
 @pytest.fixture(name="tox_project")
 def init_fixture(
     tmp_path: Path, capfd: CaptureFixture, monkeypatch: MonkeyPatch, mocker: MockerFixture
 ) -> ToxProjectCreator:
-    def _init(files: Dict[str, Any], base: Optional[Path] = None) -> ToxProject:
+    def _init(files: Dict[str, Any], base: Optional[Path] = None, prj_path: Optional[Path] = None) -> ToxProject:
         """create tox  projects"""
-        return ToxProject(files, base, tmp_path / "p", capfd, monkeypatch, mocker)
+        return ToxProject(files, base, prj_path or tmp_path / "p", capfd, monkeypatch, mocker)
 
     return _init  # noqa
 

tests/session/cmd/test_show_config.py

@@ -1,6 +1,8 @@
 import platform
 import sys
 from configparser import ConfigParser
+from pathlib import Path
+from textwrap import dedent
 from typing import Callable, Tuple
 
 import pytest
@@ -155,3 +157,27 @@ def test_show_config_description_normalize(tox_project: ToxProjectCreator) -> No
     outcome = tox_project({"tox.ini": tox_ini}).run("c", "-e", "py", "-k", "description")
     outcome.assert_success()
     assert outcome.out == "[testenv:py]\ndescription = A magical pipe of this\n"
+
+
+def test_show_config_ini_comment_path(tox_project: ToxProjectCreator, tmp_path: Path) -> None:
+    prj_path = tmp_path / "#magic"
+    prj_path.mkdir()
+    ini = """
+    [testenv]
+    package = skip
+    set_env =
+        A=1 # comment
+        # more comment
+    commands = {envpython} -c 'import os; print(os.linesep.join(f"{k}={v!r}" for k, v in os.environ.items()))'
+    [testenv:py]
+    set_env =
+        {[testenv]set_env}
+        B = {tox_root} # just some comment
+    """
+    project = tox_project({"tox.ini": dedent(ini)}, prj_path=prj_path)
+    result = project.run("r", "-e", "py")
+    result.assert_success()
+    a_line = next(i for i in result.out.splitlines() if i.startswith("A="))  # pragma: no branch  # not found raises
+    assert a_line == "A='1'"
+    b_line = next(i for i in result.out.splitlines() if i.startswith("B="))  # pragma: no branch  # not found raises
+    assert b_line == f"B='{prj_path}'"