BUG: suppress all uses of ANSI terminal escapes when not supported

Author: dnicolodi

mesonpy/__init__.py

@@ -18,6 +18,7 @@
 import functools
 import importlib.machinery
 import io
+import itertools
 import json
 import os
 import pathlib
@@ -56,7 +57,7 @@
 if typing.TYPE_CHECKING:  # pragma: no cover
     from typing import Any, Callable, DefaultDict, Dict, List, Literal, Optional, Sequence, TextIO, Tuple, Type, TypeVar, Union
 
-    from mesonpy._compat import Collection, Iterator, Mapping, ParamSpec, Path
+    from mesonpy._compat import Collection, Iterator, Mapping, ParamSpec, Path, Self
 
     P = ParamSpec('P')
     T = TypeVar('T')
@@ -194,6 +195,26 @@ def _showwarning(
     _log(f'{style.WARNING}meson-python: warning:{style.RESET} {message}')
 
 
+class _clicounter:
+    def __init__(self, total: int) -> None:
+        self._total = total
+        self._count = itertools.count(start=1)
+
+    def __enter__(self) -> Self:
+        return self
+
+    def update(self, description: str) -> None:
+        line = f'[{next(self._count)}/{self._total}] {description}'
+        if _use_ansi_escapes():
+            print('\r', line, sep='', end='\33[0K', flush=True)
+        else:
+            print(line)
+
+    def __exit__(self, exc_type: Any, exc_value: Any, exc_tb: Any) -> None:
+        if _use_ansi_escapes():
+            print()
+
+
 class Error(RuntimeError):
     def __str__(self) -> str:
         return str(self.args[0])
@@ -441,7 +462,7 @@ def build(self, directory: Path) -> pathlib.Path:
         with mesonpy._wheelfile.WheelFile(wheel_file, 'w') as whl:
             self._wheel_write_metadata(whl)
 
-            with mesonpy._util.clicounter(sum(len(x) for x in self._manifest.values())) as counter:
+            with _clicounter(sum(len(x) for x in self._manifest.values())) as counter:
 
                 root = 'purelib' if self._pure else 'platlib'
 

mesonpy/_util.py

@@ -8,19 +8,15 @@
 
 import contextlib
 import gzip
-import itertools
 import os
-import sys
 import tarfile
 import typing
 
 from typing import IO
 
 
 if typing.TYPE_CHECKING:  # pragma: no cover
-    from typing import Any
-
-    from mesonpy._compat import Iterator, Path, Self
+    from mesonpy._compat import Iterator, Path
 
 
 @contextlib.contextmanager
@@ -53,26 +49,6 @@ def create_targz(path: Path) -> Iterator[tarfile.TarFile]:
         yield tar
 
 
-class clicounter:
-    def __init__(self, total: int) -> None:
-        self._total = total
-        self._count = itertools.count(start=1)
-
-    def __enter__(self) -> Self:
-        return self
-
-    def update(self, description: str) -> None:
-        line = f'[{next(self._count)}/{self._total}] {description}'
-        if sys.stdout.isatty():
-            print('\r', line, sep='', end='\33[0K', flush=True)
-        else:
-            print(line)
-
-    def __exit__(self, exc_type: Any, exc_value: Any, exc_tb: Any) -> None:
-        if sys.stdout.isatty():
-            print()
-
-
 def setup_windows_console() -> bool:
     from ctypes import byref, windll  # type: ignore
     from ctypes.wintypes import DWORD

tests/test_output.py

@@ -18,7 +18,7 @@
     (True, {'TERM': ''}, True),
     (True, {'TERM': 'dumb'}, False),
 ])
-def test_use_ansi_colors(mocker, monkeypatch, tty, env, colors):
+def test_use_ansi_escapes(mocker, monkeypatch, tty, env, colors):
     mocker.patch('sys.stdout.isatty', return_value=tty)
     mocker.patch('mesonpy._util.setup_windows_console', return_value=True)
     monkeypatch.delenv('NO_COLOR', raising=False)
@@ -27,6 +27,6 @@ def test_use_ansi_colors(mocker, monkeypatch, tty, env, colors):
         monkeypatch.setenv(key, value)
 
     # Clear caching by functools.lru_cache().
-    mesonpy._use_ansi_colors.cache_clear()
+    mesonpy._use_ansi_escapes.cache_clear()
 
-    assert mesonpy._use_ansi_colors() == colors
+    assert mesonpy._use_ansi_escapes() == colors