robot.htmldata package

Package for writing output files in HTML format.

This package is considered stable, but it is not part of the public API.

Submodules

robot.htmldata.htmlfilewriter module

class robot.htmldata.htmlfilewriter.HtmlFileWriter(output: io.TextIOBase, model_writer: robot.htmldata.htmlfilewriter.ModelWriter)[source]

Bases: object

write(template: pathlib.Path | str[pathlib.Path, str])[source]
class robot.htmldata.htmlfilewriter.Writer[source]

Bases: abc.ABC

handles_line = None
handles(line: str)[source]
write(line: str)[source]
class robot.htmldata.htmlfilewriter.ModelWriter[source]

Bases: robot.htmldata.htmlfilewriter.Writer, abc.ABC

handles_line = '<!-- JS MODEL -->'
handles(line: str)
write(line: str)
class robot.htmldata.htmlfilewriter.LineWriter(output: io.TextIOBase)[source]

Bases: robot.htmldata.htmlfilewriter.Writer

handles(line: str)[source]
write(line: str)[source]
handles_line = None
class robot.htmldata.htmlfilewriter.GeneratorWriter(writer: robot.utils.markupwriters.HtmlWriter)[source]

Bases: robot.htmldata.htmlfilewriter.Writer

handles_line = '<meta name="Generator" content='
write(line: str)[source]
handles(line: str)
class robot.htmldata.htmlfilewriter.InliningWriter(writer: robot.utils.markupwriters.HtmlWriter, base_dir: pathlib.Path)[source]

Bases: robot.htmldata.htmlfilewriter.Writer, abc.ABC

inline_file(path: pathlib.Path | str[pathlib.Path, str], tag: str, attrs: dict)[source]
handles(line: str)
handles_line = None
write(line: str)
class robot.htmldata.htmlfilewriter.JsFileWriter(writer: robot.utils.markupwriters.HtmlWriter, base_dir: pathlib.Path)[source]

Bases: robot.htmldata.htmlfilewriter.InliningWriter

handles_line = '<script type="text/javascript" src='
write(line: str)[source]
handles(line: str)
inline_file(path: pathlib.Path | str[pathlib.Path, str], tag: str, attrs: dict)
class robot.htmldata.htmlfilewriter.CssFileWriter(writer: robot.utils.markupwriters.HtmlWriter, base_dir: pathlib.Path)[source]

Bases: robot.htmldata.htmlfilewriter.InliningWriter

handles_line = '<link rel="stylesheet"'
write(line: str)[source]
handles(line: str)
inline_file(path: pathlib.Path | str[pathlib.Path, str], tag: str, attrs: dict)

robot.htmldata.jsonwriter module

class robot.htmldata.jsonwriter.JsonWriter(output, separator='')[source]

Bases: object

write_json(prefix, data, postfix=';\n', mapping=None, separator=True)[source]
write(string, postfix=';\n', separator=True)[source]
class robot.htmldata.jsonwriter.JsonDumper(output)[source]

Bases: object

dump(data, mapping=None)[source]
class robot.htmldata.jsonwriter.StringDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

dump(data, mapping)[source]
handles(data, mapping)
class robot.htmldata.jsonwriter.IntegerDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

dump(data, mapping)[source]
handles(data, mapping)
class robot.htmldata.jsonwriter.DictDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

dump(data, mapping)[source]
handles(data, mapping)
class robot.htmldata.jsonwriter.TupleListDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

dump(data, mapping)[source]
handles(data, mapping)
class robot.htmldata.jsonwriter.MappingDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

handles(data, mapping)[source]
dump(data, mapping)[source]
class robot.htmldata.jsonwriter.NoneDumper(jsondumper)[source]

Bases: robot.htmldata.jsonwriter._Dumper

handles(data, mapping)[source]
dump(data, mapping)[source]

robot.htmldata.template module

class robot.htmldata.template.HtmlTemplate(path: pathlib.Path | str[pathlib.Path, str])[source]

Bases: collections.abc.Iterable