Provides message formatting as text.
Definition at line 122 of file outputs.py.
◆ __init__()
def grepros.outputs.TextSinkMixin.__init__ |
( |
|
self, |
|
|
|
args = None , |
|
|
** |
kwargs |
|
) |
| |
@param args arguments as namespace or dictionary, case-insensitive
@param args.color False or "never" for not using colors in replacements
@param args.highlight highlight matched values (default true)
@param args.emit_field message fields to emit if not all
@param args.noemit_field message fields to skip in output
@param args.max_field_lines maximum number of lines to output per field
@param args.start_line message line number to start output from
@param args.end_line message line number to stop output at
@param args.max_message_lines maximum number of lines to output per message
@param args.lines_around_match number of message lines around matched fields to output
@param args.matched_fields_only output only the fields where match was found
@param args.wrap_width character width to wrap message YAML output at
@param args.match_wrapper string to wrap around matched values,
both sides if one value, start and end if more than one,
or no wrapping if zero values
@param kwargs any and all arguments as keyword overrides, case-insensitive
Reimplemented in grepros.outputs.ConsoleSink, and grepros.plugins.auto.html.HtmlSink.
Definition at line 134 of file outputs.py.
◆ _configure()
def grepros.outputs.TextSinkMixin._configure |
( |
|
self, |
|
|
|
args |
|
) |
| |
|
private |
Initializes output settings.
Definition at line 290 of file outputs.py.
◆ format_message()
def grepros.outputs.TextSinkMixin.format_message |
( |
|
self, |
|
|
|
msg, |
|
|
|
highlight = False |
|
) |
| |
◆ message_to_yaml()
def grepros.outputs.TextSinkMixin.message_to_yaml |
( |
|
self, |
|
|
|
val, |
|
|
|
top = () , |
|
|
|
typename = None |
|
) |
| |
Returns ROS message or other value as YAML.
Definition at line 202 of file outputs.py.
◆ _format_repls
grepros.outputs.TextSinkMixin._format_repls |
|
private |
◆ _patterns
grepros.outputs.TextSinkMixin._patterns |
|
private |
◆ _prefix
grepros.outputs.TextSinkMixin._prefix |
|
private |
◆ _styles
grepros.outputs.TextSinkMixin._styles |
|
private |
◆ _wrapper
grepros.outputs.TextSinkMixin._wrapper |
|
private |
◆ DEFAULT_ARGS
grepros.outputs.TextSinkMixin.DEFAULT_ARGS |
|
static |
Initial value:= dict(COLOR=True, EMIT_FIELD=(), NOEMIT_FIELD=(), HIGHLIGHT=True,
MAX_FIELD_LINES=None, START_LINE=None, END_LINE=None,
MAX_MESSAGE_LINES=None, LINES_AROUND_MATCH=None, MATCHED_FIELDS_ONLY=False,
WRAP_WIDTH=None, MATCH_WRAPPER=None)
Constructor argument defaults.
Definition at line 129 of file outputs.py.
◆ NOCOLOR_HIGHLIGHT_WRAPPERS
string grepros.outputs.TextSinkMixin.NOCOLOR_HIGHLIGHT_WRAPPERS = "**", "**" |
|
static |
Default highlight wrappers if not color output.
Definition at line 126 of file outputs.py.
The documentation for this class was generated from the following file: