docs/changelog.rst

@@ -4,6 +4,18 @@ Release History
 
 .. towncrier release notes start
 
+v4.1.1 (2022-12-29)
+-------------------
+
+Bugfixes - 4.1.1
+~~~~~~~~~~~~~~~~
+- Fix logging error with emoji in git branch name. (:issue:`2768`)
+
+Improved Documentation - 4.1.1
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- Add faq entry about re-use of environments - by :user:`jugmac00`. (:issue:`2788`)
+
+
 v4.1.0 (2022-12-29)
 -------------------
 

docs/faq.rst

@@ -121,6 +121,23 @@ tox 4 -- output changes
 - We now use colors for reporting, to help make the output easier to read for humans. This can be disabled via the
   ``TERM=dumb`` or ``NO_COLOR=1`` environment variables, or the ``--colored no`` CLI argument.
 
+tox 4 -- re-use of environments
++++++++++++++++++++++++++++++++
+
+- It is no longer possible to re-use environments. While this might have been possible with tox version 3, this
+  behavior was never supported, and possibly caused wrong results as illustrated in the following example.
+
+.. code-block:: ini
+
+    [testenv]
+    envdir = .tox/venv
+
+    [testenv:a]
+    deps = pytest>7
+
+    [testenv:b]
+    deps = pytest<7
+
 New features in tox 4
 ---------------------
 Here is a non-exhaustive list of these.

src/tox/pytest.py

@@ -161,7 +161,7 @@ def _setup_files(dest: Path, base: Path | None, content: dict[str, Any]) -> None
                 at_path.mkdir(exist_ok=True)
                 ToxProject._setup_files(at_path, None, value)
             elif isinstance(value, str):
-                at_path.write_text(textwrap.dedent(value))
+                at_path.write_text(textwrap.dedent(value), encoding="utf-8")
             elif value is None:
                 at_path.mkdir()
             else:

src/tox/tox_env/api.py

@@ -444,7 +444,7 @@ def _log_execute(self, request: ExecuteRequest, status: ExecuteStatus) -> None:
 
     @staticmethod
     def _write_execute_log(env_name: str, log_file: Path, request: ExecuteRequest, status: ExecuteStatus) -> None:
-        with log_file.open("wt") as file:
+        with log_file.open("wt", encoding="utf-8") as file:
             file.write(f"name: {env_name}\n")
             file.write(f"run_id: {request.run_id}\n")
             for env_key, env_value in request.env.items():

tests/tox_env/test_tox_env_api.py

@@ -34,7 +34,8 @@ def test_allow_list_external_fail(tox_project: ToxProjectCreator, fake_exe_on_pa
 
 def test_env_log(tox_project: ToxProjectCreator) -> None:
     cmd = "commands=python -c 'import sys; print(1); print(2); print(3, file=sys.stderr); print(4, file=sys.stderr)'"
-    prj = tox_project({"tox.ini": f"[testenv]\npackage=skip\n{cmd}"})
+    env_vars = "    UNPREDICTABLE = 🪟"
+    prj = tox_project({"tox.ini": f"[testenv]\npackage=skip\nset_env =\n{env_vars}\n{cmd}"})
     result_first = prj.run("r")
     result_first.assert_success()