robot.utils.markupwriters._MarkupWriter Class Reference

Inheritance diagram for robot.utils.markupwriters._MarkupWriter:

Public Member Functions
def	__init__ (self, output, write_empty=True, usage=None)
	:param output: Either an opened, file like object, or a path to the desired output file. More...
def	close (self)
	Closes the underlying output file. More...
def	content (self, content=None, escape=True, newline=False)
def	element (self, name, content=None, attrs=None, escape=True, newline=True)
def	end (self, name, newline=True)
def	start (self, name, attrs=None, newline=True)

Public Attributes
	output

Private Member Functions
def	_escape (self, content)
def	_format_attrs (self, attrs)
def	_order_attrs (self, attrs)
def	_preamble (self)
def	_start (self, name, attrs, newline)
def	_write (self, text, newline=False)

Private Attributes
	_write_empty

Detailed Description

Definition at line 21 of file markupwriters.py.

Constructor & Destructor Documentation

__init__()

def robot.utils.markupwriters._MarkupWriter.__init__	(		self,
			output,
			write_empty = True,
			usage = None
	)

:param output: Either an opened, file like object, or a path to the desired output file.

In the latter case, the file is created and clients should use :py:meth:close method to close it. :param write_empty: Whether to write empty elements and attributes.

Definition at line 29 of file markupwriters.py.

Member Function Documentation

_escape()

def robot.utils.markupwriters._MarkupWriter._escape (   self,   content  )

private

Reimplemented in robot.utils.markupwriters.XmlWriter, and robot.utils.markupwriters.HtmlWriter.

Definition at line 61 of file markupwriters.py.

_format_attrs()

def robot.utils.markupwriters._MarkupWriter._format_attrs (   self,   attrs  )

private

Definition at line 46 of file markupwriters.py.

_order_attrs()

def robot.utils.markupwriters._MarkupWriter._order_attrs (   self,   attrs  )

private

Reimplemented in robot.utils.markupwriters.HtmlWriter.

Definition at line 54 of file markupwriters.py.

_preamble()

def robot.utils.markupwriters._MarkupWriter._preamble (   self )

private

Reimplemented in robot.utils.markupwriters.XmlWriter.

Definition at line 36 of file markupwriters.py.

_start()

def robot.utils.markupwriters._MarkupWriter._start (   self,   name,   attrs,   newline  )

private

Definition at line 43 of file markupwriters.py.

_write()

def robot.utils.markupwriters._MarkupWriter._write (   self,   text,   newline = False  )

private

Definition at line 78 of file markupwriters.py.

close()

def robot.utils.markupwriters._MarkupWriter.close

(

self

)

Closes the underlying output file.

Definition at line 75 of file markupwriters.py.

content()

def robot.utils.markupwriters._MarkupWriter.content	(		self,
			content = None,
			escape = True,
			newline = False
	)

Definition at line 57 of file markupwriters.py.

element()

def robot.utils.markupwriters._MarkupWriter.element	(		self,
			name,
			content = None,
			attrs = None,
			escape = True,
			newline = True
	)

Reimplemented in robot.utils.markupwriters.XmlWriter.

Definition at line 67 of file markupwriters.py.

end()

def robot.utils.markupwriters._MarkupWriter.end	(		self,
			name,
			newline = True
	)

Definition at line 64 of file markupwriters.py.

start()

def robot.utils.markupwriters._MarkupWriter.start	(		self,
			name,
			attrs = None,
			newline = True
	)

Definition at line 39 of file markupwriters.py.

Member Data Documentation

_write_empty

robot.utils.markupwriters._MarkupWriter._write_empty

private

Definition at line 33 of file markupwriters.py.

output

robot.utils.markupwriters._MarkupWriter.output

Definition at line 32 of file markupwriters.py.

---

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

• src/robot/utils/markupwriters.py