pyopmspe11.utils.terminal module
Format command-line messages for pyopmspe11.
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
Stream.
- Returns:
- bool
Whether the requested condition is satisfied.
- 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.
- codestr
Code.
- streamobject, optional
Stream.
- Returns:
- str
Generated filename or formatted text.
- Parameters:
-
- Return type:
str
-
cli_warning_value(value)[source]
Format a deprecated CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Generated filename or formatted text.
- Parameters:
value (str)
- Return type:
str
-
cli_correct_value(value)[source]
Format a correct CLI option or value.
- Parameters:
- valuestr
Value to inspect.
- Returns:
- str
Generated filename or formatted text.
- 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
Generated filename or formatted text.
- 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
Generated filename or formatted text.
- Parameters:
value (str)
- Return type:
str
-
pyopmspe11_error(message)[source]
Raise a fatal command-line error.
- Parameters:
- messagestr
Validation message to append.
- Parameters:
message (str)
- Return type:
NoReturn
-
pyopmspe11_warning(message)[source]
Display a non-fatal command-line warning.
- Parameters:
- messagestr
Validation message to append.
- Parameters:
message (str)
- Return type:
None
-
pyopmspe11_info(message)[source]
Display an informational command-line message.
- Parameters:
- messagestr
Validation message to append.
- Parameters:
message (str)
- Return type:
None
-
pyopmspe11_tip(message)[source]
Display a command-line suggestion.
- Parameters:
- messagestr
Validation message to append.
- Parameters:
message (str)
- Return type:
None
-
pyopmspe11_success(msg, output_dir, filenames)[source]
Display the generated output location and filenames.
- Parameters:
- msgstr
Error message used for invalid injection settings.
- output_dirstr
Output dir.
- filenameslist[str]
Filenames.
- Parameters:
-
- Return type:
None
-
pyopmspe11_name(stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>)[source]
Format the pyopmspe11 program name.
- Parameters:
- streamobject, optional
Stream.
- Returns:
- str
Generated filename or formatted text.
- Parameters:
stream (object)
- Return type:
str
