Renamed rich_utils.allow_style to rich_utils.ALLOW_STYLE to be consistent with our other global settings.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -1172,12 +1172,12 @@ def allow_style_type(value: str) -> ru.AllowStyle:
     @property
     def allow_style(self) -> ru.AllowStyle:
         """Read-only property needed to support do_set when it reads allow_style."""
-        return ru.allow_style
+        return ru.ALLOW_STYLE
 
     @allow_style.setter
     def allow_style(self, new_val: ru.AllowStyle) -> None:
         """Setter property needed to support do_set when it updates allow_style."""
-        ru.allow_style = new_val
+        ru.ALLOW_STYLE = new_val
 
     def _completion_supported(self) -> bool:
         """Return whether tab completion is supported."""

cmd2/rich_utils.py

@@ -28,7 +28,7 @@
 
 
 class AllowStyle(Enum):
-    """Values for ``cmd2.rich_utils.allow_style``."""
+    """Values for ``cmd2.rich_utils.ALLOW_STYLE``."""
 
     ALWAYS = 'Always'  # Always output ANSI style sequences
     NEVER = 'Never'  # Remove ANSI style sequences from all output
@@ -44,7 +44,7 @@ def __repr__(self) -> str:
 
 
 # Controls when ANSI style sequences are allowed in output
-allow_style = AllowStyle.TERMINAL
+ALLOW_STYLE = AllowStyle.TERMINAL
 
 
 class Cmd2Theme(Theme):
@@ -123,13 +123,13 @@ def __init__(self, file: IO[str] | None = None) -> None:
         force_terminal: bool | None = None
         force_interactive: bool | None = None
 
-        if allow_style == AllowStyle.ALWAYS:
+        if ALLOW_STYLE == AllowStyle.ALWAYS:
             force_terminal = True
 
             # Turn off interactive mode if dest is not actually a terminal which supports it
             tmp_console = Console(file=file)
             force_interactive = tmp_console.is_interactive
-        elif allow_style == AllowStyle.NEVER:
+        elif ALLOW_STYLE == AllowStyle.NEVER:
             force_terminal = False
 
         # Configure console defaults to treat output as plain, unstructured text.

tests/test_cmd2.py

@@ -49,12 +49,12 @@ def arg_decorator(func):
 
         @functools.wraps(func)
         def cmd_wrapper(*args, **kwargs):
-            old = ru.allow_style
-            ru.allow_style = style
+            old = ru.ALLOW_STYLE
+            ru.ALLOW_STYLE = style
             try:
                 retval = func(*args, **kwargs)
             finally:
-                ru.allow_style = old
+                ru.ALLOW_STYLE = old
             return retval
 
         return cmd_wrapper
@@ -244,20 +244,20 @@ def test_set_no_settables(base_app) -> None:
 )
 def test_set_allow_style(base_app, new_val, is_valid, expected) -> None:
     # Initialize allow_style for this test
-    ru.allow_style = ru.AllowStyle.TERMINAL
+    ru.ALLOW_STYLE = ru.AllowStyle.TERMINAL
 
     # Use the set command to alter it
     out, err = run_cmd(base_app, f'set allow_style {new_val}')
     assert base_app.last_result is is_valid
 
     # Verify the results
-    assert ru.allow_style == expected
+    assert expected == ru.ALLOW_STYLE
     if is_valid:
         assert not err
         assert out
 
     # Reset allow_style to its default since it's an application-wide setting that can affect other unit tests
-    ru.allow_style = ru.AllowStyle.TERMINAL
+    ru.ALLOW_STYLE = ru.AllowStyle.TERMINAL
 
 
 def test_set_with_choices(base_app) -> None: