Environment.environ instead of os.environ

Author: happz

pyproject.toml

@@ -455,6 +455,8 @@ builtins-ignorelist = ["help", "format", "input", "filter", "copyright", "max"]
 "pathlib.PosixPath".msg = "Use tmt._compat.pathlib.Path instead."
 "pydantic".msg = "Use tmt._compat.pydantic instead."
 "warnings.deprecated".msg = "Use tmt._compat.warnings.deprecated instead."
+"os.environ".msg = "Use tmt.utils.environment.Environment.environ instead."
+"os.getenv".msg = "Use tmt.utils.environment.Environment.environ instead."
 "os.path".msg = "Use tmt._compat.pathlib.Path and pathlib instead."
 # Banning builtins is not yet supported: https://github.com/astral-sh/ruff/issues/10079
 # "builtins.open".msg = "Use Path.{write_text,append_text,read_text,write_bytes,read_bytes} instead."

tests/core/environment-file/data/environment_file_data.py

@@ -1,7 +1,7 @@
-import os
-
 import pytest
 
+from tmt.utils import Environment
+
 env_vars_parametrization = (
     ("env_name", "value"),
     (
@@ -18,4 +18,4 @@
 
 @pytest.mark.parametrize(*env_vars_parametrization)
 def test_environment_file_with_variables(env_name, value):
-    assert os.environ[env_name] == value
+    assert Environment.environ[env_name] == value

tests/execute/tty/data/python.py

@@ -3,7 +3,7 @@
 import os
 import sys
 
-step = os.getenv('STEP', '')
+step = os.getenv('STEP', '')  # noqa: TID251
 
 isatty = (sys.stdin.isatty(), sys.stdout.isatty(), sys.stderr.isatty())
 

tests/execute/tty/ptty-wrapper

@@ -7,6 +7,6 @@ import os
 import pty
 import sys
 
-os.environ["TERM"] = "vt100"
+os.environ["TERM"] = "vt100"  # noqa: TID251
 exit_status = pty.spawn(("/bin/bash", "-c", " ".join(sys.argv[1:])))
 sys.exit(os.waitstatus_to_exitcode(exit_status))

tests/unit/test_base.py

@@ -13,7 +13,7 @@
 import tmt.utils
 from tmt.base.core import FmfId, expand_node_data
 from tmt.base.links import Link, LinkNeedle, Links
-from tmt.utils import Path, SpecificationError
+from tmt.utils import Environment, Path, SpecificationError
 
 if TYPE_CHECKING:
     from tests import RunTmt
@@ -294,7 +294,7 @@ def test_expand_node_data(monkeypatch) -> None:
 
     expected = [*_expected, [*_expected], {f'key{i}': value for i, value in enumerate(_expected)}]
 
-    for envvar in os.environ:
+    for envvar in Environment.environ:
         monkeypatch.delenv(envvar)
 
     for envvar, value in environ.items():

tests/unit/test_utils.py

@@ -178,14 +178,14 @@ def test_inject_auth_git_url(monkeypatch) -> None:
     """
 
     # empty environment
-    monkeypatch.setattr('os.environ', {})
+    monkeypatch.setattr('Environment.environ', {})
     assert inject_auth_git_url('input_text') == 'input_text'
 
     suffix = '_glab'
     # https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#clone-repository-using-personal-access-token
     # username can be anything but cannot be an empty string
     monkeypatch.setattr(
-        'os.environ',
+        'Environment.environ',
         {
             f'{tmt.utils.git.INJECT_CREDENTIALS_URL_PREFIX}{suffix}': 'https://gitlab.com/namespace/project',
             f'{tmt.utils.git.INJECT_CREDENTIALS_VALUE_PREFIX}{suffix}': 'foo:abcdefgh',
@@ -201,7 +201,7 @@ def test_inject_auth_git_url(monkeypatch) -> None:
     # https://github.blog/2012-09-21-easier-builds-and-deployments-using-git-over-https-and-oauth/
     # just token or username is used (value before @)
     monkeypatch.setattr(
-        'os.environ',
+        'Environment.environ',
         {
             f'{tmt.utils.git.INJECT_CREDENTIALS_URL_PREFIX}{suffix}': 'https://github.com/namespace/project',
             f'{tmt.utils.git.INJECT_CREDENTIALS_VALUE_PREFIX}{suffix}': 'abcdefgh',

tmt/config/__init__.py

@@ -1,5 +1,4 @@
 import functools
-import os
 from contextlib import suppress
 from typing import Optional, TypeVar, cast
 
@@ -29,8 +28,8 @@ def effective_config_dir() -> Path:
     :py:const:`DEFAULT_CONFIG_DIR` is picked.
     """
 
-    if 'TMT_CONFIG_DIR' in os.environ:
-        return Path(os.environ['TMT_CONFIG_DIR']).expanduser()
+    if 'TMT_CONFIG_DIR' in tmt.utils.Environment.environ:
+        return Path(tmt.utils.Environment.environ['TMT_CONFIG_DIR']).expanduser()
 
     return DEFAULT_CONFIG_DIR.expanduser()
 

tmt/guest/__init__.py

@@ -181,7 +181,7 @@ def configure_ssh_options() -> tmt.utils.RawCommand:
 
     options: tmt.utils.RawCommand = []
 
-    for name, value in os.environ.items():
+    for name, value in Environment.environ.items():
         match = re.match(r'TMT_SSH_([a-zA-Z_]+)', name)
 
         if not match:

tmt/libraries/beakerlib.py

@@ -363,7 +363,7 @@ def _do_fetch(self, directory: Path) -> None:
         else:
             self.parent.debug(f"Cloning '{self.identifier}' for '{self}'.", level=3)
 
-            environment = Environment.from_environ()
+            environment = Environment.environ
             environment["GIT_ASKPASS"] = EnvVarValue("echo")
 
             tmt.utils.git.git_clone(

tmt/log.py

@@ -29,7 +29,6 @@
 import io
 import itertools
 import logging
-import os
 import sys
 from typing import (
     TYPE_CHECKING,
@@ -128,7 +127,7 @@ def create_decolorizer(apply_colors: bool) -> Callable[[str], str]:
 def _debug_level_from_global_envvar() -> int:
     import tmt.utils
 
-    raw_value = os.getenv('TMT_DEBUG', None)
+    raw_value = tmt.utils.Environment.environ.get('TMT_DEBUG', None)
 
     if raw_value is None:
         return 0
@@ -182,15 +181,17 @@ def decide_colorization(no_color: bool, force_color: bool) -> tuple[bool, bool]:
         for logging colorization.
     """
 
+    from tmt.utils import Environment
+
     # Default values: assume colors & unicorns everywhere.
     apply_colors_output = apply_colors_logging = True
 
     # Enforce colors if `--force-color` was used, or `TMT_FORCE_COLOR` envvar is set.
-    if force_color or 'TMT_FORCE_COLOR' in os.environ:
+    if force_color or 'TMT_FORCE_COLOR' in Environment.environ:
         apply_colors_output = apply_colors_logging = True
 
     # Disable coloring if `--no-color` was used, or `NO_COLOR` or `TMT_NO_COLOR` envvar is set.
-    elif no_color or 'NO_COLOR' in os.environ or 'TMT_NO_COLOR' in os.environ:
+    elif no_color or 'NO_COLOR' in Environment.environ or 'TMT_NO_COLOR' in Environment.environ:
         apply_colors_output = apply_colors_logging = False
 
     # Autodetection, disable colors when not talking to a terminal.