robot.output.console.highlighting.HighlightingStream Class Reference

Public Member Functions
def	__init__ (self, stream, colors='AUTO')
def	error (self, message, level)
def	flush (self)
def	highlight (self, text, status=None, flush=True)
def	write (self, text, flush=True)

Public Attributes
	stream

Properties
	_suppress_broken_pipe_error = property

Private Member Functions
def	_get_highlighter (self, stream, colors)
def	_highlighting (self, status)
def	_must_flush_before_and_after_highlighting (self)
def	_suppress_broken_pipe_error (self)
def	_write (self, text, retry=5)

Private Attributes
	_highlighter

Detailed Description

Definition at line 33 of file highlighting.py.

Constructor & Destructor Documentation

__init__()

def robot.output.console.highlighting.HighlightingStream.__init__	(		self,
			stream,
			colors = 'AUTO'
	)

Definition at line 35 of file highlighting.py.

Member Function Documentation

_get_highlighter()

def robot.output.console.highlighting.HighlightingStream._get_highlighter (   self,   stream,   colors  )

private

Definition at line 39 of file highlighting.py.

_highlighting()

def robot.output.console.highlighting.HighlightingStream._highlighting (   self,   status  )

private

Definition at line 101 of file highlighting.py.

_must_flush_before_and_after_highlighting()

def robot.output.console.highlighting.HighlightingStream._must_flush_before_and_after_highlighting (   self )

private

Definition at line 89 of file highlighting.py.

_suppress_broken_pipe_error()

def robot.output.console.highlighting.HighlightingStream._suppress_broken_pipe_error (   self )

private

Definition at line 71 of file highlighting.py.

_write()

def robot.output.console.highlighting.HighlightingStream._write (   self,   text,   retry = 5  )

private

Definition at line 56 of file highlighting.py.

error()

def robot.output.console.highlighting.HighlightingStream.error	(		self,
			message,
			level
	)

Definition at line 95 of file highlighting.py.

flush()

def robot.output.console.highlighting.HighlightingStream.flush

(

self

)

Definition at line 78 of file highlighting.py.

highlight()

def robot.output.console.highlighting.HighlightingStream.highlight	(		self,
			text,
			status = None,
			flush = True
	)

Definition at line 82 of file highlighting.py.

write()

def robot.output.console.highlighting.HighlightingStream.write	(		self,
			text,
			flush = True
	)

Definition at line 51 of file highlighting.py.

Member Data Documentation

_highlighter

robot.output.console.highlighting.HighlightingStream._highlighter

private

Definition at line 37 of file highlighting.py.

stream

robot.output.console.highlighting.HighlightingStream.stream

Definition at line 36 of file highlighting.py.

Property Documentation

_suppress_broken_pipe_error

robot.output.console.highlighting.HighlightingStream._suppress_broken_pipe_error = property

staticprivate

Definition at line 69 of file highlighting.py.

---

The documentation for this class was generated from the following file:

• src/robot/output/console/highlighting.py