expreccs.utils.terminal module
Format command-line messages for expreccs.
The module applies ANSI colors when supported by the selected output stream and
provides consistent formatting for values, errors, warnings, tips, progress
messages, and generated-file reports.
-
_supports_color(stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>)[source]
Check whether an output stream supports ANSI colors.
- Parameters:
- streamobject, optional
Output stream used for color detection.
- Returns:
- bool
Whether the stream supports ANSI color output.
- Parameters:
stream (object)
- Return type:
bool
-
_colorize(text, code, stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>)[source]
Wrap text in an ANSI color sequence when supported.
- Parameters:
- textstr
Text to format.
- codestr
ANSI color code.
- streamobject, optional
Output stream used for color detection.
- Returns:
- str
Original or ANSI-colored text.
- Parameters:
-
- Return type:
str
-
cli_warning_value(value)[source]
Format a warning-related CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Formatted value.
- Parameters:
value (str)
- Return type:
str
-
cli_correct_value(value)[source]
Format a valid CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Formatted value.
- Parameters:
value (str)
- Return type:
str
-
cli_error_value(value)[source]
Format an invalid CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Formatted value.
- Parameters:
value (str)
- Return type:
str
-
cli_info_value(value)[source]
Format an informational CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Formatted value.
- Parameters:
value (str)
- Return type:
str
-
expreccs_error(message)[source]
Raise a fatal command-line error.
- Parameters:
- messagestr
Message to append or display.
- Raises:
- SystemExit
Always raised with the formatted message.
- Parameters:
message (str)
- Return type:
NoReturn
-
expreccs_warning(message)[source]
Display a non-fatal command-line warning.
- Parameters:
- messagestr
Message to append or display.
- Parameters:
message (str)
- Return type:
None
-
expreccs_info(message)[source]
Display an informational command-line message.
- Parameters:
- messagestr
Message to append or display.
- Parameters:
message (str)
- Return type:
None
-
expreccs_tip(message)[source]
Display a command-line suggestion.
- Parameters:
- messagestr
Message to append or display.
- Parameters:
message (str)
- Return type:
None
-
expreccs_success(msg, output_dir, filenames)[source]
Display generated output locations and filenames.
- Parameters:
- msgstr
Text written before the output path.
- output_dirstr
Output directory.
- filenameslist[str]
Generated filenames.
- Parameters:
-
- Return type:
None
-
expreccs_name(stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>)[source]
Format the expreccs program name.
- Parameters:
- streamobject, optional
Output stream used for color detection.
- Returns:
- str
Formatted program name.
- Parameters:
stream (object)
- Return type:
str
