`iXBRLViewerPlugin.xhtmlserialize`¶

Module Contents¶

Classes¶

`EscapeMode`
`XHTMLSerializer`

Data¶

`XHTML_NS`
`XML_NS`

API¶

iXBRLViewerPlugin.xhtmlserialize.XHTML_NS¶: ‘http://www.w3.org/1999/xhtml’

iXBRLViewerPlugin.xhtmlserialize.XML_NS¶: ‘http://www.w3.org/XML/1998/namespace’

class iXBRLViewerPlugin.xhtmlserialize.EscapeMode¶

Bases: enum.Enum

DEFAULT¶: 0

STYLE¶: 1

class iXBRLViewerPlugin.xhtmlserialize.XHTMLSerializer(fout: IO[bytes], xml_declaration: bool = True, assume_xhtml: bool = True)¶

Initialization

SELF_CLOSABLE¶: (‘area’, ‘base’, ‘basefont’, ‘br’, ‘col’, ‘frame’, ‘hr’, ‘img’, ‘input’, ‘isindex’, ‘link’, ‘meta’, …

ESCAPES¶: None

MUST_ESCAPE_CHARS¶: ‘<&\u0001-\u0008\u000B\u000C\u000E\u001F\u007F-\u009F’

CDATA_END¶: ‘]]>’

ESCAPE_RE¶: ‘compile(…)’

ATTR_ESCAPE_RE¶: ‘compile(…)’

STYLE_ESCAPE_RE¶: ‘compile(…)’

write(s: str) → None¶

prefix_sort(p: str | None) → str¶

qname_for_node(node: lxml.etree._Element) → str¶

qname_for_attr(tag: lxml.etree._Element | str, nsmap: dict[str | None, str]) → str¶

is_selfclosable(n: lxml.etree._Element | str) → bool¶

escape_attr(s: str) → str¶

xmlns_declaration(prefix: str | None, uri: str) → str¶

namespace_declarations(new_nsmap: dict[str | None, str], cur_nsmap: dict[str | None, str]) → list[str]¶

escape_str(c: str) → str¶

write_escape_text(s: str | None, escape_mode: iXBRLViewerPlugin.xhtmlserialize.EscapeMode) → None¶

write_attributes(node: lxml.etree._Element) → None¶

write_comment(n: lxml.etree._Comment, escape_mode: iXBRLViewerPlugin.xhtmlserialize.EscapeMode) → None¶

write_processing_instruction(n: lxml.etree._ProcessingInstruction, escape_mode: iXBRLViewerPlugin.xhtmlserialize.EscapeMode) → None¶

write_node(n: lxml.etree._Element, nsmap: dict[str | None, str] | None = None, escape_mode: iXBRLViewerPlugin.xhtmlserialize.EscapeMode = EscapeMode.DEFAULT) → None¶

write_element(n: lxml.etree._Element, parent_nsmap: dict[str | None, str] | None = None, escape_mode: iXBRLViewerPlugin.xhtmlserialize.EscapeMode = EscapeMode.DEFAULT) → None¶

write_xml_declaration(docinfo: lxml.etree.DocInfo | None = None) → None¶

serialize(element: lxml.etree._ElementTree[lxml.etree._Element] | lxml.etree._Element) → None¶