summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rwxr-xr-xREADME.md2
-rw-r--r--cmd2/ansi.py50
-rw-r--r--cmd2/cmd2.py48
-rw-r--r--cmd2/transcript.py8
-rw-r--r--cmd2/utils.py10
-rw-r--r--docs/features/generating_output.rst12
-rw-r--r--docs/features/settings.rst4
-rwxr-xr-xexamples/colors.py14
-rwxr-xr-xexamples/plumbum_colors.py14
-rw-r--r--examples/transcripts/exampleSession.txt2
-rw-r--r--examples/transcripts/transcript_regex.txt2
-rw-r--r--tests/conftest.py4
-rw-r--r--tests/scripts/postcmds.txt2
-rw-r--r--tests/scripts/precmds.txt2
-rw-r--r--tests/test_ansi.py4
-rwxr-xr-xtests/test_cmd2.py68
-rw-r--r--tests/transcripts/regex_set.txt2
17 files changed, 126 insertions, 122 deletions
diff --git a/README.md b/README.md
index 7b68965f..f90875de 100755
--- a/README.md
+++ b/README.md
@@ -317,7 +317,7 @@ example/transcript_regex.txt:
# The regex for editor will match whatever program you use.
# regexes on prompts just make the trailing space obvious
(Cmd) set
-allow_ansi: Terminal
+allow_style: Terminal
continuation_prompt: >/ /
debug: False
echo: False
diff --git a/cmd2/ansi.py b/cmd2/ansi.py
index c875a9d1..57b204ca 100644
--- a/cmd2/ansi.py
+++ b/cmd2/ansi.py
@@ -1,5 +1,8 @@
# coding=utf-8
-"""Support for ANSI escape sequences which are used for things like applying style to text"""
+"""
+Support for ANSI escape sequences which are used for things like applying style to text,
+setting the window title, and asynchronous alerts.
+ """
import functools
import re
from typing import Any, IO
@@ -11,16 +14,17 @@ from wcwidth import wcswidth
# On Windows, filter ANSI escape codes out of text sent to stdout/stderr, and replace them with equivalent Win32 calls
colorama.init(strip=False)
-# Values for allow_ansi setting
-ANSI_NEVER = 'Never'
-ANSI_TERMINAL = 'Terminal'
-ANSI_ALWAYS = 'Always'
+# Values for allow_style setting
+STYLE_NEVER = 'Never'
+STYLE_TERMINAL = 'Terminal'
+STYLE_ALWAYS = 'Always'
-# Controls when ANSI escape sequences are allowed in output
-allow_ansi = ANSI_TERMINAL
+# Controls when ANSI style style sequences are allowed in output
+allow_style = STYLE_TERMINAL
-# Regular expression to match ANSI escape sequences
-ANSI_ESCAPE_RE = re.compile(r'\x1b[^m]*m')
+# Regular expression to match ANSI style sequences
+# This matches: colorama.ansi.CSI + digit(s) + m
+ANSI_STYLE_RE = re.compile(r'\033\[[0-9]+m')
# Foreground color presets
FG_COLORS = {
@@ -71,41 +75,41 @@ RESET_ALL = Style.RESET_ALL
BRIGHT = Style.BRIGHT
NORMAL = Style.NORMAL
-# ANSI escape sequences not provided by colorama
+# ANSI style sequences not provided by colorama
UNDERLINE_ENABLE = colorama.ansi.code_to_chars(4)
UNDERLINE_DISABLE = colorama.ansi.code_to_chars(24)
-def strip_ansi(text: str) -> str:
+def strip_style(text: str) -> str:
"""
- Strip ANSI escape sequences from a string.
+ Strip ANSI style sequences from a string.
- :param text: string which may contain ANSI escape sequences
- :return: the same string with any ANSI escape sequences removed
+ :param text: string which may contain ANSI style sequences
+ :return: the same string with any ANSI style sequences removed
"""
- return ANSI_ESCAPE_RE.sub('', text)
+ return ANSI_STYLE_RE.sub('', text)
def ansi_safe_wcswidth(text: str) -> int:
"""
- Wrap wcswidth to make it compatible with strings that contains ANSI escape sequences
+ Wrap wcswidth to make it compatible with strings that contains ANSI style sequences
:param text: the string being measured
"""
- # Strip ANSI escape sequences since they cause wcswidth to return -1
- return wcswidth(strip_ansi(text))
+ # Strip ANSI style sequences since they cause wcswidth to return -1
+ return wcswidth(strip_style(text))
def ansi_aware_write(fileobj: IO, msg: str) -> None:
"""
- Write a string to a fileobject and strip its ANSI escape sequences if required by allow_ansi setting
+ Write a string to a fileobject and strip its ANSI style sequences if required by allow_style setting
:param fileobj: the file object being written to
:param msg: the string being written
"""
- if allow_ansi.lower() == ANSI_NEVER.lower() or \
- (allow_ansi.lower() == ANSI_TERMINAL.lower() and not fileobj.isatty()):
- msg = strip_ansi(msg)
+ if allow_style.lower() == STYLE_NEVER.lower() or \
+ (allow_style.lower() == STYLE_TERMINAL.lower() and not fileobj.isatty()):
+ msg = strip_style(msg)
fileobj.write(msg)
@@ -176,7 +180,7 @@ def style(text: Any, *, fg: str = '', bg: str = '', bold: bool = False, underlin
additions.append(UNDERLINE_ENABLE)
removals.append(UNDERLINE_DISABLE)
- # Combine the ANSI escape sequences with the text
+ # Combine the ANSI style sequences with the text
return "".join(additions) + text + "".join(removals)
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 9120c6af..8a97761d 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -206,11 +206,11 @@ class Cmd(cmd.Cmd):
# To make an attribute settable with the "do_set" command, add it to this ...
self.settable = \
{
- # allow_ansi is a special case in which it's an application-wide setting defined in ansi.py
- 'allow_ansi': ('Allow ANSI escape sequences in output '
- '(valid values: {}, {}, {})'.format(ansi.ANSI_TERMINAL,
- ansi.ANSI_ALWAYS,
- ansi.ANSI_NEVER)),
+ # allow_style is a special case in which it's an application-wide setting defined in ansi.py
+ 'allow_style': ('Allow ANSI style sequences in output '
+ '(valid values: {}, {}, {})'.format(ansi.STYLE_TERMINAL,
+ ansi.STYLE_ALWAYS,
+ ansi.STYLE_NEVER)),
'continuation_prompt': 'On 2nd+ line of input',
'debug': 'Show full error stack on error',
'echo': 'Echo command issued into output',
@@ -366,7 +366,7 @@ class Cmd(cmd.Cmd):
else:
# Here is the meaning of the various flags we are using with the less command:
# -S causes lines longer than the screen width to be chopped (truncated) rather than wrapped
- # -R causes ANSI "color" escape sequences to be output in raw form (i.e. colors are displayed)
+ # -R causes ANSI "style" escape sequences to be output in raw form (i.e. colors are displayed)
# -X disables sending the termcap initialization and deinitialization strings to the terminal
# -F causes less to automatically exit if the entire file can be displayed on the first screen
self.pager = 'less -RXF'
@@ -395,23 +395,23 @@ class Cmd(cmd.Cmd):
# ----- Methods related to presenting output to the user -----
@property
- def allow_ansi(self) -> str:
- """Read-only property needed to support do_set when it reads allow_ansi"""
- return ansi.allow_ansi
+ def allow_style(self) -> str:
+ """Read-only property needed to support do_set when it reads allow_style"""
+ return ansi.allow_style
- @allow_ansi.setter
- def allow_ansi(self, new_val: str) -> None:
- """Setter property needed to support do_set when it updates allow_ansi"""
+ @allow_style.setter
+ def allow_style(self, new_val: str) -> None:
+ """Setter property needed to support do_set when it updates allow_style"""
new_val = new_val.lower()
- if new_val == ansi.ANSI_TERMINAL.lower():
- ansi.allow_ansi = ansi.ANSI_TERMINAL
- elif new_val == ansi.ANSI_ALWAYS.lower():
- ansi.allow_ansi = ansi.ANSI_ALWAYS
- elif new_val == ansi.ANSI_NEVER.lower():
- ansi.allow_ansi = ansi.ANSI_NEVER
+ if new_val == ansi.STYLE_TERMINAL.lower():
+ ansi.allow_style = ansi.STYLE_TERMINAL
+ elif new_val == ansi.STYLE_ALWAYS.lower():
+ ansi.allow_style = ansi.STYLE_ALWAYS
+ elif new_val == ansi.STYLE_NEVER.lower():
+ ansi.allow_style = ansi.STYLE_NEVER
else:
- self.perror('Invalid value: {} (valid values: {}, {}, {})'.format(new_val, ansi.ANSI_TERMINAL,
- ansi.ANSI_ALWAYS, ansi.ANSI_NEVER))
+ self.perror('Invalid value: {} (valid values: {}, {}, {})'.format(new_val, ansi.STYLE_TERMINAL,
+ ansi.STYLE_ALWAYS, ansi.STYLE_NEVER))
def _completion_supported(self) -> bool:
"""Return whether tab completion is supported"""
@@ -419,14 +419,14 @@ class Cmd(cmd.Cmd):
@property
def visible_prompt(self) -> str:
- """Read-only property to get the visible prompt with any ANSI escape codes stripped.
+ """Read-only property to get the visible prompt with any ANSI style escape codes stripped.
Used by transcript testing to make it easier and more reliable when users are doing things like coloring the
prompt using ANSI color codes.
:return: prompt stripped of any ANSI escape codes
"""
- return ansi.strip_ansi(self.prompt)
+ return ansi.strip_style(self.prompt)
def poutput(self, msg: Any = '', *, end: str = '\n') -> None:
"""Print message to self.stdout and appends a newline by default
@@ -551,8 +551,8 @@ class Cmd(cmd.Cmd):
# Don't attempt to use a pager that can block if redirecting or running a script (either text or Python)
# Also only attempt to use a pager if actually running in a real fully functional terminal
if functional_terminal and not self._redirecting and not self.in_pyscript() and not self.in_script():
- if ansi.allow_ansi.lower() == ansi.ANSI_NEVER.lower():
- msg_str = ansi.strip_ansi(msg_str)
+ if ansi.allow_style.lower() == ansi.STYLE_NEVER.lower():
+ msg_str = ansi.strip_style(msg_str)
msg_str += end
pager = self.pager
diff --git a/cmd2/transcript.py b/cmd2/transcript.py
index 25a79310..940c97db 100644
--- a/cmd2/transcript.py
+++ b/cmd2/transcript.py
@@ -56,13 +56,13 @@ class Cmd2TestCase(unittest.TestCase):
def _test_transcript(self, fname: str, transcript):
line_num = 0
finished = False
- line = ansi.strip_ansi(next(transcript))
+ line = ansi.strip_style(next(transcript))
line_num += 1
while not finished:
# Scroll forward to where actual commands begin
while not line.startswith(self.cmdapp.visible_prompt):
try:
- line = ansi.strip_ansi(next(transcript))
+ line = ansi.strip_style(next(transcript))
except StopIteration:
finished = True
break
@@ -89,7 +89,7 @@ class Cmd2TestCase(unittest.TestCase):
result = self.cmdapp.stdout.read()
stop_msg = 'Command indicated application should quit, but more commands in transcript'
# Read the expected result from transcript
- if ansi.strip_ansi(line).startswith(self.cmdapp.visible_prompt):
+ if ansi.strip_style(line).startswith(self.cmdapp.visible_prompt):
message = '\nFile {}, line {}\nCommand was:\n{}\nExpected: (nothing)\nGot:\n{}\n'.format(
fname, line_num, command, result)
self.assertTrue(not (result.strip()), message)
@@ -97,7 +97,7 @@ class Cmd2TestCase(unittest.TestCase):
self.assertFalse(stop, stop_msg)
continue
expected = []
- while not ansi.strip_ansi(line).startswith(self.cmdapp.visible_prompt):
+ while not ansi.strip_style(line).startswith(self.cmdapp.visible_prompt):
expected.append(line)
try:
line = next(transcript)
diff --git a/cmd2/utils.py b/cmd2/utils.py
index 9dd7a30b..ddb9f3b5 100644
--- a/cmd2/utils.py
+++ b/cmd2/utils.py
@@ -641,7 +641,7 @@ def align_text(text: str, alignment: TextAlignment, *, fill_char: str = ' ',
width: Optional[int] = None, tab_width: int = 4) -> str:
"""
Align text for display within a given width. Supports characters with display widths greater than 1.
- ANSI escape sequences are safely ignored and do not count toward the display width. This means colored text is
+ ANSI style sequences are safely ignored and do not count toward the display width. This means colored text is
supported. If text has line breaks, then each line is aligned independently.
There are convenience wrappers around this function: align_left(), align_center(), and align_right()
@@ -688,7 +688,7 @@ def align_text(text: str, alignment: TextAlignment, *, fill_char: str = ' ',
text_buf.write('\n')
# Use ansi_safe_wcswidth to support characters with display widths
- # greater than 1 as well as ANSI escape sequences
+ # greater than 1 as well as ANSI style sequences
line_width = ansi.ansi_safe_wcswidth(line)
if line_width == -1:
raise(ValueError("Text to align contains an unprintable character"))
@@ -728,7 +728,7 @@ def align_text(text: str, alignment: TextAlignment, *, fill_char: str = ' ',
def align_left(text: str, *, fill_char: str = ' ', width: Optional[int] = None, tab_width: int = 4) -> str:
"""
Left align text for display within a given width. Supports characters with display widths greater than 1.
- ANSI escape sequences are safely ignored and do not count toward the display width. This means colored text is
+ ANSI style sequences are safely ignored and do not count toward the display width. This means colored text is
supported. If text has line breaks, then each line is aligned independently.
:param text: text to left align (can contain multiple lines)
@@ -746,7 +746,7 @@ def align_left(text: str, *, fill_char: str = ' ', width: Optional[int] = None,
def align_center(text: str, *, fill_char: str = ' ', width: Optional[int] = None, tab_width: int = 4) -> str:
"""
Center text for display within a given width. Supports characters with display widths greater than 1.
- ANSI escape sequences are safely ignored and do not count toward the display width. This means colored text is
+ ANSI style sequences are safely ignored and do not count toward the display width. This means colored text is
supported. If text has line breaks, then each line is aligned independently.
:param text: text to center (can contain multiple lines)
@@ -764,7 +764,7 @@ def align_center(text: str, *, fill_char: str = ' ', width: Optional[int] = None
def align_right(text: str, *, fill_char: str = ' ', width: Optional[int] = None, tab_width: int = 4) -> str:
"""
Right align text for display within a given width. Supports characters with display widths greater than 1.
- ANSI escape sequences are safely ignored and do not count toward the display width. This means colored text is
+ ANSI style sequences are safely ignored and do not count toward the display width. This means colored text is
supported. If text has line breaks, then each line is aligned independently.
:param text: text to right align (can contain multiple lines)
diff --git a/docs/features/generating_output.rst b/docs/features/generating_output.rst
index 2ee820f1..e83b5fdf 100644
--- a/docs/features/generating_output.rst
+++ b/docs/features/generating_output.rst
@@ -45,23 +45,23 @@ changing the value of the ``quiet`` setting.
Colored Output
--------------
-The output methods in the previous section all honor the ``allow_ansi``
+The output methods in the previous section all honor the ``allow_style``
setting, which has three possible values:
Never
- poutput(), pfeedback(), and ppaged() strip all ANSI escape sequences
+ poutput(), pfeedback(), and ppaged() strip all ANSI style sequences
which instruct the terminal to colorize output
Terminal
(the default value) poutput(), pfeedback(), and ppaged() do not strip any
- ANSI escape sequences when the output is a terminal, but if the output is a
- pipe or a file the escape sequences are stripped. If you want colorized
- output you must add ANSI escape sequences using either cmd2's internal ansi
+ ANSI style sequences when the output is a terminal, but if the output is a
+ pipe or a file the style sequences are stripped. If you want colorized
+ output you must add ANSI style sequences using either cmd2's internal ansi
module or another color library such as `plumbum.colors`, `colorama`, or
`colored`.
Always
- poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences,
+ poutput(), pfeedback(), and ppaged() never strip ANSI style sequences,
regardless of the output destination
Colored and otherwise styled output can be generated using the `ansi.style()`
diff --git a/docs/features/settings.rst b/docs/features/settings.rst
index b0575468..7cc0d727 100644
--- a/docs/features/settings.rst
+++ b/docs/features/settings.rst
@@ -46,7 +46,7 @@ comments, is viewable from within a running application
with::
(Cmd) set --long
- allow_ansi: Terminal # Allow ANSI escape sequences in output (valid values: Terminal, Always, Never)
+ allow_style: Terminal # Allow ANSI style sequences in output (valid values: Terminal, Always, Never)
continuation_prompt: > # On 2nd+ line of input
debug: False # Show full error stack on error
echo: False # Echo command issued into output
@@ -61,7 +61,7 @@ with::
Any of these user-settable parameters can be set while running your app with
the ``set`` command like so::
- set allow_ansi Never
+ set allow_style Never
diff --git a/examples/colors.py b/examples/colors.py
index 8c54dfa4..ea8be479 100755
--- a/examples/colors.py
+++ b/examples/colors.py
@@ -6,21 +6,21 @@ A sample application for cmd2. Demonstrating colorized output.
Experiment with the command line options on the `speak` command to see how
different output colors ca
-The allow_ansi setting has three possible values:
+The allow_style setting has three possible values:
Never
- poutput(), pfeedback(), and ppaged() strip all ANSI escape sequences
+ poutput(), pfeedback(), and ppaged() strip all ANSI style sequences
which instruct the terminal to colorize output
Terminal
(the default value) poutput(), pfeedback(), and ppaged() do not strip any
- ANSI escape sequences when the output is a terminal, but if the output is
- a pipe or a file the escape sequences are stripped. If you want colorized
- output you must add ANSI escape sequences using either cmd2's internal ansi
+ ANSI style sequences when the output is a terminal, but if the output is
+ a pipe or a file the style sequences are stripped. If you want colorized
+ output you must add ANSI style sequences using either cmd2's internal ansi
module or another color library such as `plumbum.colors` or `colorama`.
Always
- poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences,
+ poutput(), pfeedback(), and ppaged() never strip ANSI style sequences,
regardless of the output destination
"""
import argparse
@@ -40,7 +40,7 @@ class CmdLineApp(cmd2.Cmd):
self.settable['maxrepeats'] = 'max repetitions for speak command'
# Should ANSI color output be allowed
- self.allow_ansi = ansi.ANSI_TERMINAL
+ self.allow_style = ansi.STYLE_TERMINAL
speak_parser = argparse.ArgumentParser()
speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
diff --git a/examples/plumbum_colors.py b/examples/plumbum_colors.py
index a969c4de..8eaf3fe8 100755
--- a/examples/plumbum_colors.py
+++ b/examples/plumbum_colors.py
@@ -6,21 +6,21 @@ A sample application for cmd2. Demonstrating colorized output using the plumbum
Experiment with the command line options on the `speak` command to see how
different output colors ca
-The allow_ansi setting has three possible values:
+The allow_style setting has three possible values:
Never
- poutput(), pfeedback(), and ppaged() strip all ANSI escape sequences
+ poutput(), pfeedback(), and ppaged() strip all ANSI style sequences
which instruct the terminal to colorize output
Terminal
(the default value) poutput(), pfeedback(), and ppaged() do not strip any
- ANSI escape sequences when the output is a terminal, but if the output is
- a pipe or a file the escape sequences are stripped. If you want colorized
- output you must add ANSI escape sequences using either cmd2's internal ansi
+ ANSI style sequences when the output is a terminal, but if the output is
+ a pipe or a file the style sequences are stripped. If you want colorized
+ output you must add ANSI style sequences using either cmd2's internal ansi
module or another color library such as `plumbum.colors` or `colorama`.
Always
- poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences,
+ poutput(), pfeedback(), and ppaged() never strip ANSI style sequences,
regardless of the output destination
WARNING: This example requires the plumbum package, which isn't normally required by cmd2.
@@ -78,7 +78,7 @@ class CmdLineApp(cmd2.Cmd):
self.settable['maxrepeats'] = 'max repetitions for speak command'
# Should ANSI color output be allowed
- self.allow_ansi = ansi.ANSI_TERMINAL
+ self.allow_style = ansi.STYLE_TERMINAL
speak_parser = argparse.ArgumentParser()
speak_parser.add_argument('-p', '--piglatin', action='store_true', help='atinLay')
diff --git a/examples/transcripts/exampleSession.txt b/examples/transcripts/exampleSession.txt
index 3e579c28..5a75235b 100644
--- a/examples/transcripts/exampleSession.txt
+++ b/examples/transcripts/exampleSession.txt
@@ -3,7 +3,7 @@
# The regex for editor will match whatever program you use.
# regexes on prompts just make the trailing space obvious
(Cmd) set
-allow_ansi: /(Terminal|Always|Never)/
+allow_style: /(Terminal|Always|Never)/
continuation_prompt: >/ /
debug: False
echo: False
diff --git a/examples/transcripts/transcript_regex.txt b/examples/transcripts/transcript_regex.txt
index d94c442b..276f7d22 100644
--- a/examples/transcripts/transcript_regex.txt
+++ b/examples/transcripts/transcript_regex.txt
@@ -3,7 +3,7 @@
# The regex for editor will match whatever program you use.
# regexes on prompts just make the trailing space obvious
(Cmd) set
-allow_ansi: /(Terminal|Always|Never)/
+allow_style: /(Terminal|Always|Never)/
continuation_prompt: >/ /
debug: False
echo: False
diff --git a/tests/conftest.py b/tests/conftest.py
index 6b7c5aff..3d4059d9 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -88,7 +88,7 @@ SHORTCUTS_TXT = """Shortcuts for other commands:
"""
# Output from the show command with default settings
-SHOW_TXT = """allow_ansi: Terminal
+SHOW_TXT = """allow_style: Terminal
continuation_prompt: >
debug: False
echo: False
@@ -102,7 +102,7 @@ timing: False
"""
SHOW_LONG = """
-allow_ansi: Terminal # Allow ANSI escape sequences in output (valid values: Terminal, Always, Never)
+allow_style: Terminal # Allow ANSI style sequences in output (valid values: Terminal, Always, Never)
continuation_prompt: > # On 2nd+ line of input
debug: False # Show full error stack on error
echo: False # Echo command issued into output
diff --git a/tests/scripts/postcmds.txt b/tests/scripts/postcmds.txt
index 74f1e226..30f47055 100644
--- a/tests/scripts/postcmds.txt
+++ b/tests/scripts/postcmds.txt
@@ -1 +1 @@
-set allow_ansi Never
+set allow_style Never
diff --git a/tests/scripts/precmds.txt b/tests/scripts/precmds.txt
index 0167aa22..7d036acf 100644
--- a/tests/scripts/precmds.txt
+++ b/tests/scripts/precmds.txt
@@ -1 +1 @@
-set allow_ansi Always
+set allow_style Always
diff --git a/tests/test_ansi.py b/tests/test_ansi.py
index 056bb2db..4f7ab652 100644
--- a/tests/test_ansi.py
+++ b/tests/test_ansi.py
@@ -10,11 +10,11 @@ import cmd2.ansi as ansi
HELLO_WORLD = 'Hello, world!'
-def test_strip_ansi():
+def test_strip_style():
base_str = HELLO_WORLD
ansi_str = ansi.style(base_str, fg='green')
assert base_str != ansi_str
- assert base_str == ansi.strip_ansi(ansi_str)
+ assert base_str == ansi.strip_style(ansi_str)
def test_ansi_safe_wcswidth():
diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py
index 9a0218f2..b5473609 100755
--- a/tests/test_cmd2.py
+++ b/tests/test_cmd2.py
@@ -187,26 +187,26 @@ now: True
assert out == ['quiet: True']
@pytest.mark.parametrize('new_val, is_valid, expected', [
- (ansi.ANSI_NEVER, False, ansi.ANSI_NEVER),
- ('neVeR', False, ansi.ANSI_NEVER),
- (ansi.ANSI_TERMINAL, False, ansi.ANSI_TERMINAL),
- ('TeRMInal', False, ansi.ANSI_TERMINAL),
- (ansi.ANSI_ALWAYS, False, ansi.ANSI_ALWAYS),
- ('AlWaYs', False, ansi.ANSI_ALWAYS),
- ('invalid', True, ansi.ANSI_TERMINAL),
+ (ansi.STYLE_NEVER, False, ansi.STYLE_NEVER),
+ ('neVeR', False, ansi.STYLE_NEVER),
+ (ansi.STYLE_TERMINAL, False, ansi.STYLE_TERMINAL),
+ ('TeRMInal', False, ansi.STYLE_TERMINAL),
+ (ansi.STYLE_ALWAYS, False, ansi.STYLE_ALWAYS),
+ ('AlWaYs', False, ansi.STYLE_ALWAYS),
+ ('invalid', True, ansi.STYLE_TERMINAL),
])
-def test_set_allow_ansi(base_app, new_val, is_valid, expected):
- # Initialize allow_ansi for this test
- ansi.allow_ansi = ansi.ANSI_TERMINAL
+def test_set_allow_style(base_app, new_val, is_valid, expected):
+ # Initialize allow_style for this test
+ ansi.allow_style = ansi.STYLE_TERMINAL
# Use the set command to alter it
- out, err = run_cmd(base_app, 'set allow_ansi {}'.format(new_val))
+ out, err = run_cmd(base_app, 'set allow_style {}'.format(new_val))
# Verify the results
assert bool(err) == is_valid
- assert ansi.allow_ansi == expected
+ assert ansi.allow_style == expected
- # Reload ansi module to reset allow_ansi to its default since it's an
+ # Reload ansi module to reset allow_style to its default since it's an
# application-wide setting that can affect other unit tests.
import importlib
importlib.reload(ansi)
@@ -376,11 +376,11 @@ def test_run_script_nested_run_scripts(base_app, request):
expected = """
%s
_relative_run_script precmds.txt
-set allow_ansi Always
+set allow_style Always
help
shortcuts
_relative_run_script postcmds.txt
-set allow_ansi Never""" % initial_run
+set allow_style Never""" % initial_run
out, err = run_cmd(base_app, 'history -s')
assert out == normalize(expected)
@@ -395,11 +395,11 @@ def test_runcmds_plus_hooks(base_app, request):
'run_script ' + postfilepath])
expected = """
run_script %s
-set allow_ansi Always
+set allow_style Always
help
shortcuts
run_script %s
-set allow_ansi Never""" % (prefilepath, postfilepath)
+set allow_style Never""" % (prefilepath, postfilepath)
out, err = run_cmd(base_app, 'history -s')
assert out == normalize(expected)
@@ -1530,7 +1530,7 @@ def test_poutput_none(outsim_app):
def test_poutput_ansi_always(outsim_app):
msg = 'Hello World'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
colored_msg = ansi.style(msg, fg='cyan')
outsim_app.poutput(colored_msg)
out = outsim_app.stdout.getvalue()
@@ -1540,7 +1540,7 @@ def test_poutput_ansi_always(outsim_app):
def test_poutput_ansi_never(outsim_app):
msg = 'Hello World'
- ansi.allow_ansi = ansi.ANSI_NEVER
+ ansi.allow_style = ansi.STYLE_NEVER
colored_msg = ansi.style(msg, fg='cyan')
outsim_app.poutput(colored_msg)
out = outsim_app.stdout.getvalue()
@@ -1851,7 +1851,7 @@ def test_nonexistent_macro(base_app):
def test_perror_style(base_app, capsys):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
base_app.perror(msg)
out, err = capsys.readouterr()
assert err == ansi.style_error(msg) + end
@@ -1859,7 +1859,7 @@ def test_perror_style(base_app, capsys):
def test_perror_no_style(base_app, capsys):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
base_app.perror(msg, apply_style=False)
out, err = capsys.readouterr()
assert err == msg + end
@@ -1867,7 +1867,7 @@ def test_perror_no_style(base_app, capsys):
def test_pwarning_style(base_app, capsys):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
base_app.pwarning(msg)
out, err = capsys.readouterr()
assert err == ansi.style_warning(msg) + end
@@ -1875,7 +1875,7 @@ def test_pwarning_style(base_app, capsys):
def test_pwarning_no_style(base_app, capsys):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
base_app.pwarning(msg, apply_style=False)
out, err = capsys.readouterr()
assert err == msg + end
@@ -1902,7 +1902,7 @@ def test_ppaged_none(outsim_app):
def test_ppaged_strips_ansi_when_redirecting(outsim_app):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_TERMINAL
+ ansi.allow_style = ansi.STYLE_TERMINAL
outsim_app._redirecting = True
outsim_app.ppaged(ansi.style(msg, fg='red'))
out = outsim_app.stdout.getvalue()
@@ -1911,7 +1911,7 @@ def test_ppaged_strips_ansi_when_redirecting(outsim_app):
def test_ppaged_strips_ansi_when_redirecting_if_always(outsim_app):
msg = 'testing...'
end = '\n'
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
outsim_app._redirecting = True
colored_msg = ansi.style(msg, fg='red')
outsim_app.ppaged(colored_msg)
@@ -2078,13 +2078,13 @@ class AnsiApp(cmd2.Cmd):
def test_ansi_pouterr_always_tty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
mocker.patch.object(app.stdout, 'isatty', return_value=True)
mocker.patch.object(sys.stderr, 'isatty', return_value=True)
app.onecmd_plus_hooks('echo_error oopsie')
out, err = capsys.readouterr()
- # if colors are on, the output should have some escape sequences in it
+ # if colors are on, the output should have some ANSI style sequences in it
assert len(out) > len('oopsie\n')
assert 'oopsie' in out
assert len(err) > len('oopsie\n')
@@ -2100,13 +2100,13 @@ def test_ansi_pouterr_always_tty(mocker, capsys):
def test_ansi_pouterr_always_notty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_ALWAYS
+ ansi.allow_style = ansi.STYLE_ALWAYS
mocker.patch.object(app.stdout, 'isatty', return_value=False)
mocker.patch.object(sys.stderr, 'isatty', return_value=False)
app.onecmd_plus_hooks('echo_error oopsie')
out, err = capsys.readouterr()
- # if colors are on, the output should have some escape sequences in it
+ # if colors are on, the output should have some ANSI style sequences in it
assert len(out) > len('oopsie\n')
assert 'oopsie' in out
assert len(err) > len('oopsie\n')
@@ -2122,12 +2122,12 @@ def test_ansi_pouterr_always_notty(mocker, capsys):
def test_ansi_terminal_tty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_TERMINAL
+ ansi.allow_style = ansi.STYLE_TERMINAL
mocker.patch.object(app.stdout, 'isatty', return_value=True)
mocker.patch.object(sys.stderr, 'isatty', return_value=True)
app.onecmd_plus_hooks('echo_error oopsie')
- # if colors are on, the output should have some escape sequences in it
+ # if colors are on, the output should have some ANSI style sequences in it
out, err = capsys.readouterr()
assert len(out) > len('oopsie\n')
assert 'oopsie' in out
@@ -2143,7 +2143,7 @@ def test_ansi_terminal_tty(mocker, capsys):
def test_ansi_terminal_notty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_TERMINAL
+ ansi.allow_style = ansi.STYLE_TERMINAL
mocker.patch.object(app.stdout, 'isatty', return_value=False)
mocker.patch.object(sys.stderr, 'isatty', return_value=False)
@@ -2157,7 +2157,7 @@ def test_ansi_terminal_notty(mocker, capsys):
def test_ansi_never_tty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_NEVER
+ ansi.allow_style = ansi.STYLE_NEVER
mocker.patch.object(app.stdout, 'isatty', return_value=True)
mocker.patch.object(sys.stderr, 'isatty', return_value=True)
@@ -2171,7 +2171,7 @@ def test_ansi_never_tty(mocker, capsys):
def test_ansi_never_notty(mocker, capsys):
app = AnsiApp()
- ansi.allow_ansi = ansi.ANSI_NEVER
+ ansi.allow_style = ansi.STYLE_NEVER
mocker.patch.object(app.stdout, 'isatty', return_value=False)
mocker.patch.object(sys.stderr, 'isatty', return_value=False)
diff --git a/tests/transcripts/regex_set.txt b/tests/transcripts/regex_set.txt
index fdcca3a8..17f43ede 100644
--- a/tests/transcripts/regex_set.txt
+++ b/tests/transcripts/regex_set.txt
@@ -4,7 +4,7 @@
# Regexes on prompts just make the trailing space obvious
(Cmd) set
-allow_ansi: /(Terminal|Always|Never)/
+allow_style: /(Terminal|Always|Never)/
continuation_prompt: >/ /
debug: False
echo: False
View Lorry Controller Status