Merge pull request #65 from dmerejkowsky/windows-fixes

Windows fixes

Author: dmerejkowsky

cli_ui/__init__.py

@@ -40,8 +40,7 @@
 # and over again:
 _ENABLE_XTERM_TITLE = None
 
-# should we call colorama.init()?
-_INITIALIZED = False
+colorama.init()
 
 
 # Tokens can be strings, or Color, UnicodeSequence or Symbol instances,
@@ -155,39 +154,21 @@ def __repr__(self) -> str:
         return f"Symbol({self.as_string})"
 
 
-def using_colorama() -> bool:
-    if os.name == "nt":
-        if "TERM" not in os.environ:
-            return True
-        if os.environ["TERM"] == "cygwin":
-            return True
-        return False
-    else:
-        return False
-
-
-def config_color(fileobj: FileObj) -> bool:
+def colors_enabled(fileobj: FileObj) -> bool:
     if CONFIG["color"] == "never":
         return False
     if CONFIG["color"] == "always":
         return True
     if os.name == "nt":
-        # sys.isatty() is False on mintty, so
-        # let there be colors by default. (when running on windows,
-        # people can use --color=never)
-        # Note that on Windows, when run from cmd.exe,
-        # console.init() does the right thing if sys.stdout is redirected
-        return True
+        # Color is always an opt-in on Windows,
+        # because there are two many ways for this to go wrong
+        return False
     else:
         return fileobj.isatty()
 
 
 def write_title_string(mystr: str, fileobj: FileObj) -> None:
-    if using_colorama():
-        # By-pass colorama bug:
-        # colorama/win32.py, line 154
-        #   return _SetConsoleTitleW(title)
-        # ctypes.ArgumentError: argument 1: <class 'TypeError'>: wrong type
+    if not colors_enabled(fileobj):
         return
     mystr = "\x1b]0;%s\x07" % mystr
     fileobj.write(mystr)
@@ -262,17 +243,13 @@ def message(
     """ Helper method for error, warning, info, debug
 
     """
-    if using_colorama():
-        global _INITIALIZED
-        if not _INITIALIZED:
-            colorama.init()
-            _INITIALIZED = True
+    should_use_colors = colors_enabled(fileobj)
     with_color, without_color = process_tokens(tokens, end=end, sep=sep)
     if CONFIG["record"]:
         _MESSAGES.append(without_color)
     if update_title and with_color:
         write_title_string(without_color, fileobj)
-    to_write = with_color if config_color(fileobj) else without_color
+    to_write = with_color if should_use_colors else without_color
     write_and_flush(fileobj, to_write)
 
 
@@ -434,7 +411,7 @@ def info_table(
                 plain_row.append(plain_str)
             colored_data.append(colored_row)
             plain_data.append(plain_row)
-    if config_color(fileobj):
+    if colors_enabled(fileobj):
         data_for_tabulate = colored_data
     else:
         data_for_tabulate = plain_data
@@ -670,7 +647,7 @@ def main_demo() -> None:
 
     def new_message(*args: Any, **kwargs: Any) -> None:
         old_message(*args, **kwargs)
-        time.sleep(1)
+        time.sleep(0.5)
 
     message = new_message
 

cli_ui/tests/test_cli_ui.py

@@ -1,6 +1,7 @@
 import datetime
 import io
 import operator
+import os
 import re
 from typing import Iterator
 from unittest import mock
@@ -47,12 +48,19 @@ def dumb_tty() -> DumbTTY:
 
 @pytest.fixture
 def toggle_timestamp() -> Iterator[None]:
-    cli_ui.CONFIG["timestamp"] = True
+    cli_ui.setup(timestamp=True)
     yield
-    cli_ui.CONFIG["timestamp"] = False
+    cli_ui.setup(timestamp=False)
 
 
-def test_info_stdout_is_a_tty(smart_tty: io.StringIO) -> None:
+@pytest.fixture
+def always_color() -> Iterator[None]:
+    cli_ui.setup(color="always")
+    yield
+    cli_ui.setup(color="auto")
+
+
+def test_info_with_colors(always_color: None, smart_tty: io.StringIO) -> None:
     # fmt: off
     cli_ui.info(
         cli_ui.red, "this is red", cli_ui.reset,
@@ -67,7 +75,7 @@ def test_info_stdout_is_a_tty(smart_tty: io.StringIO) -> None:
     assert actual == expected
 
 
-def test_update_title(smart_tty: SmartTTY) -> None:
+def test_update_title(always_color: None, smart_tty: SmartTTY) -> None:
     # fmt: off
     cli_ui.info(
         "Something", cli_ui.bold, "bold",
@@ -83,7 +91,7 @@ def test_update_title(smart_tty: SmartTTY) -> None:
     assert actual == expected
 
 
-def test_info_stdout_is_not_a_tty(dumb_tty: DumbTTY) -> None:
+def test_info_stdout_no_colors(dumb_tty: DumbTTY) -> None:
     # fmt: off
     cli_ui.info(
         cli_ui.red, "this is red", cli_ui.reset,
@@ -96,12 +104,18 @@ def test_info_stdout_is_not_a_tty(dumb_tty: DumbTTY) -> None:
     assert actual == expected
 
 
-def test_info_characters(smart_tty: SmartTTY) -> None:
+def test_info_characters(always_color: None, smart_tty: SmartTTY) -> None:
     cli_ui.info(
         "Doing stuff", cli_ui.ellipsis, "sucess", cli_ui.check, fileobj=smart_tty
     )
     actual = smart_tty.getvalue()
-    expected = f"Doing stuff {RESET_ALL}{RESET_ALL}… {RESET_ALL}sucess {RESET_ALL}{GREEN}✓ {RESET_ALL}\n{RESET_ALL}"
+    if os.name == "nt":
+        success = "ok"
+        ellipsis = "..."
+    else:
+        success = "✓"
+        ellipsis = "…"
+    expected = f"Doing stuff {RESET_ALL}{RESET_ALL}{ellipsis} {RESET_ALL}sucess {RESET_ALL}{GREEN}{success} {RESET_ALL}\n{RESET_ALL}"
     assert actual == expected
 
 
@@ -150,7 +164,7 @@ def test_table_with_dict_no_color(dumb_tty: DumbTTY) -> None:
     assert actual == expected
 
 
-def test_table_with_dict_and_color(smart_tty: SmartTTY) -> None:
+def test_table_with_dict_and_color(always_color: None, smart_tty: SmartTTY) -> None:
     data = {
         (cli_ui.bold, "Name",): [(cli_ui.green, "Alice"), (cli_ui.green, "Bob")],
         (cli_ui.bold, "Age",): [(cli_ui.blue, 24), (cli_ui.blue, 9)],
@@ -168,7 +182,7 @@ def test_table_with_dict_and_color(smart_tty: SmartTTY) -> None:
     assert actual == expected
 
 
-def test_table_with_lists_with_color(smart_tty: SmartTTY) -> None:
+def test_table_with_lists_with_color(always_color: None, smart_tty: SmartTTY) -> None:
     headers = ["name", "score"]
     data = [
         [(cli_ui.bold, "John"), (cli_ui.green, 10)],

docs/changelog.rst

@@ -1,6 +1,17 @@
 Changelog
 ----------
 
+v0.14.0
++++++++
+
+* **breaking**:  Remove buggy workarounds on Windows.
+  Colors will now be off by default unless ``cli_setup()`` is called
+  with ``color="always"``. Configurations that are known to work are
+  ``cmd.exe`` and ``git-bash`` when using ``mintty``.
+
+* **breaking**:  ``colorama.init()`` is called uncoditionaly when ``cli_ui`` is
+  imported
+
 v0.13.0
 +++++++