docutils.writers.odf_odt package

Open Document Format (ODF) Writer.

This module is provisional: the API is not settled and may change with any minor Docutils version.

class _ElementInterfaceWrapper(tag, attrib=None)

Bases: Element

setparent(parent)

getparent()

Element(tag, attrib=None, nsmap=None, nsdict={'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0', 'dc': 'http://purl.org/dc/elements/1.1/', 'dom': 'http://www.w3.org/2001/xml-events', 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0', 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0', 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0', 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0', 'math': 'http://www.w3.org/1998/Math/MathML', 'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0', 'number': 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0', 'office': 'urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'ooo': 'http://openoffice.org/2004/office', 'oooc': 'http://openoffice.org/2004/calc', 'ooow': 'http://openoffice.org/2004/writer', 'presentation': 'urn:oasis:names:tc:opendocument:xmlns:presentation:1.0', 'script': 'urn:oasis:names:tc:opendocument:xmlns:script:1.0', 'style': 'urn:oasis:names:tc:opendocument:xmlns:style:1.0', 'svg': 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0', 'table': 'urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'text': 'urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'xforms': 'http://www.w3.org/2002/xforms', 'xlink': 'http://www.w3.org/1999/xlink', 'xsd': 'http://www.w3.org/2001/XMLSchema', 'xsi': 'http://www.w3.org/2001/XMLSchema-instance'})

SubElement(parent, tag, attrib=None, nsmap=None, nsdict={'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0', 'dc': 'http://purl.org/dc/elements/1.1/', 'dom': 'http://www.w3.org/2001/xml-events', 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0', 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0', 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0', 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0', 'math': 'http://www.w3.org/1998/Math/MathML', 'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0', 'number': 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0', 'office': 'urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'ooo': 'http://openoffice.org/2004/office', 'oooc': 'http://openoffice.org/2004/calc', 'ooow': 'http://openoffice.org/2004/writer', 'presentation': 'urn:oasis:names:tc:opendocument:xmlns:presentation:1.0', 'script': 'urn:oasis:names:tc:opendocument:xmlns:script:1.0', 'style': 'urn:oasis:names:tc:opendocument:xmlns:style:1.0', 'svg': 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0', 'table': 'urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'text': 'urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'xforms': 'http://www.w3.org/2002/xforms', 'xlink': 'http://www.w3.org/1999/xlink', 'xsd': 'http://www.w3.org/2001/XMLSchema', 'xsi': 'http://www.w3.org/2001/XMLSchema-instance'})

fix_ns(tag, attrib, nsdict)

add_ns(tag, nsdict={'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0', 'dc': 'http://purl.org/dc/elements/1.1/', 'dom': 'http://www.w3.org/2001/xml-events', 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0', 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0', 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0', 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0', 'math': 'http://www.w3.org/1998/Math/MathML', 'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0', 'number': 'urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0', 'office': 'urn:oasis:names:tc:opendocument:xmlns:office:1.0', 'ooo': 'http://openoffice.org/2004/office', 'oooc': 'http://openoffice.org/2004/calc', 'ooow': 'http://openoffice.org/2004/writer', 'presentation': 'urn:oasis:names:tc:opendocument:xmlns:presentation:1.0', 'script': 'urn:oasis:names:tc:opendocument:xmlns:script:1.0', 'style': 'urn:oasis:names:tc:opendocument:xmlns:style:1.0', 'svg': 'urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0', 'table': 'urn:oasis:names:tc:opendocument:xmlns:table:1.0', 'text': 'urn:oasis:names:tc:opendocument:xmlns:text:1.0', 'xforms': 'http://www.w3.org/2002/xforms', 'xlink': 'http://www.w3.org/1999/xlink', 'xsd': 'http://www.w3.org/2001/XMLSchema', 'xsi': 'http://www.w3.org/2001/XMLSchema-instance'})

ToString(et)

escape_cdata(text)

class TableStyle(border=None, backgroundcolor=None)

Bases: object

get_border_()

set_border_(border)

property border

get_backgroundcolor_()

set_backgroundcolor_(backgroundcolor)

property backgroundcolor

class ListLevel(level, sibling_level=True, nested_level=True)

Bases: object

set_sibling(sibling_level)

get_sibling()

set_nested(nested_level)

get_nested()

set_level(level)

get_level()

class Writer

Bases: Writer

MIME_TYPE = 'application/vnd.oasis.opendocument.text'

EXTENSION = '.odt'

supported = ('odt',)

Formats this writer supports.

default_stylesheet = 'styles.odt'

default_stylesheet_path = '../../../../envs/latest/lib/python3.12/site-packages/docutils/writers/odf_odt/styles.odt'

default_template = 'template.txt'

default_template_path = '../../../../envs/latest/lib/python3.12/site-packages/docutils/writers/odf_odt/template.txt'

settings_spec = ('ODF-Specific Options', None, (('Specify a stylesheet.  Default: "../../../../envs/latest/lib/python3.12/site-packages/docutils/writers/odf_odt/styles.odt"', ['--stylesheet'], {'default': '../../../../envs/latest/lib/python3.12/site-packages/docutils/writers/odf_odt/styles.odt', 'dest': 'stylesheet'}), ('Specify a configuration/mapping file relative to the current working directory for additional ODF options.  In particular, this file may contain a section named "Formats" that maps default style names to names to be used in the resulting output file allowing for adhering to external standards. For more info and the format of the configuration/mapping file, see the odtwriter doc.', ['--odf-config-file'], {'metavar': '<file>'}), ('Obfuscate email addresses to confuse harvesters while still keeping email links usable with standards-compliant browsers.', ['--cloak-email-addresses'], {'action': 'store_true', 'default': False, 'dest': 'cloak_email_addresses', 'validator': <function validate_boolean>}), ('Do not obfuscate email addresses.', ['--no-cloak-email-addresses'], {'action': 'store_false', 'default': False, 'dest': 'cloak_email_addresses', 'validator': <function validate_boolean>}), ('Specify the thickness of table borders in thousands of a cm.  Default is 35.', ['--table-border-thickness'], {'default': None, 'validator': <function validate_nonnegative_int>}), ('Add syntax highlighting in literal code blocks.', ['--add-syntax-highlighting'], {'action': 'store_true', 'default': False, 'dest': 'add_syntax_highlighting', 'validator': <function validate_boolean>}), ('Do not add syntax highlighting in literal code blocks. (default)', ['--no-syntax-highlighting'], {'action': 'store_false', 'default': False, 'dest': 'add_syntax_highlighting', 'validator': <function validate_boolean>}), ('Create sections for headers.  (default)', ['--create-sections'], {'action': 'store_true', 'default': True, 'dest': 'create_sections', 'validator': <function validate_boolean>}), ('Do not create sections for headers.', ['--no-sections'], {'action': 'store_false', 'default': True, 'dest': 'create_sections', 'validator': <function validate_boolean>}), ('Create links.', ['--create-links'], {'action': 'store_true', 'default': False, 'dest': 'create_links', 'validator': <function validate_boolean>}), ('Do not create links.  (default)', ['--no-links'], {'action': 'store_false', 'default': False, 'dest': 'create_links', 'validator': <function validate_boolean>}), ('Generate endnotes at end of document, not footnotes at bottom of page.', ['--endnotes-end-doc'], {'action': 'store_true', 'default': False, 'dest': 'endnotes_end_doc', 'validator': <function validate_boolean>}), ('Generate footnotes at bottom of page, not endnotes at end of document. (default)', ['--no-endnotes-end-doc'], {'action': 'store_false', 'default': False, 'dest': 'endnotes_end_doc', 'validator': <function validate_boolean>}), ('Generate a bullet list table of contents, not an ODF/oowriter table of contents.', ['--generate-list-toc'], {'action': 'store_false', 'default': True, 'dest': 'generate_oowriter_toc', 'validator': <function validate_boolean>}), ('Generate an ODF/oowriter table of contents, not a bullet list. (default)', ['--generate-oowriter-toc'], {'action': 'store_true', 'default': True, 'dest': 'generate_oowriter_toc', 'validator': <function validate_boolean>}), ('Specify the contents of an custom header line.  See odf_odt writer documentation for details about special field character sequences.', ['--custom-odt-header'], {'default': '', 'dest': 'custom_header'}), ('Specify the contents of an custom footer line.  See odf_odt writer documentation for details about special field character sequences.', ['--custom-odt-footer'], {'default': '', 'dest': 'custom_footer'})))

Runtime settings specification. Override in subclasses.

Defines runtime settings and associated command-line options, as used by docutils.frontend.OptionParser. This is a tuple of:

• Option group title (string or None which implies no group, just a list of single options).

• Description (string or None).

• A sequence of option tuples. Each consists of:

  • Help text (string)

  • List of option strings (e.g. ['-Q', '--quux']).

  • Dictionary of keyword arguments sent to the OptionParser/OptionGroup add_option method.

    Runtime setting names are derived implicitly from long option names (’–a-setting’ becomes settings.a_setting) or explicitly from the ‘dest’ keyword argument.

    Most settings will also have a ‘validator’ keyword & function. The validator function validates setting values (from configuration files and command-line option arguments) and converts them to appropriate types. For example, the docutils.frontend.validate_boolean function, required by all boolean settings, converts true values (‘1’, ‘on’, ‘yes’, and ‘true’) to 1 and false values (‘0’, ‘off’, ‘no’, ‘false’, and ‘’) to 0. Validators need only be set once per setting. See the docutils.frontend.validate_* functions.

    See the optparse docs for more details.

• More triples of group title, description, options, as many times as needed. Thus, settings_spec tuples can be simply concatenated.

settings_defaults = {'output_encoding_error_handler': 'xmlcharrefreplace'}

A dictionary of defaults for settings not in settings_spec (internal settings, intended to be inaccessible by command-line and config file). Override in subclasses.

relative_path_settings = ('stylesheet_path',)

Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory.

config_section = 'odf_odt writer'

The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.

config_section_dependencies = ('writers',)

A list of names of config file sections that are to be applied before config_section, in order (from general to specific). In other words, the settings in config_section are to be overlaid on top of the settings from these sections. The “general” section is assumed implicitly. Override in subclasses.

translate()

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

assemble_my_parts()

Assemble the self.parts dictionary. Extend in subclasses.

update_stylesheet(stylesheet_root, language_code, region_code)

Update xml style sheet element with language and region/country.

write_zip_str(zfile, name, bytes, compress_type=8)

store_embedded_files(zfile)

get_settings()

modeled after get_stylesheet

get_stylesheet()

Get the stylesheet from the visitor. Ask the visitor to setup the page.

copy_from_stylesheet(outzipfile)

Copy images, settings, etc from the stylesheet doc into target doc.

assemble_parts()

Assemble the self.parts dictionary. Extend in subclasses.

See <https://docutils.sourceforge.io/docs/api/publisher.html>.

create_manifest()

create_meta()

class ODFTranslator(document)

Bases: GenericNodeVisitor

used_styles = ('attribution', 'blockindent', 'blockquote', 'blockquote-bulletitem', 'blockquote-bulletlist', 'blockquote-enumitem', 'blockquote-enumlist', 'bulletitem', 'bulletlist', 'caption', 'legend', 'centeredtextbody', 'codeblock', 'codeblock-indented', 'codeblock-classname', 'codeblock-comment', 'codeblock-functionname', 'codeblock-keyword', 'codeblock-name', 'codeblock-number', 'codeblock-operator', 'codeblock-string', 'emphasis', 'enumitem', 'enumlist', 'epigraph', 'epigraph-bulletitem', 'epigraph-bulletlist', 'epigraph-enumitem', 'epigraph-enumlist', 'footer', 'footnote', 'citation', 'header', 'highlights', 'highlights-bulletitem', 'highlights-bulletlist', 'highlights-enumitem', 'highlights-enumlist', 'horizontalline', 'inlineliteral', 'quotation', 'rubric', 'strong', 'table-title', 'textbody', 'tocbulletlist', 'tocenumlist', 'title', 'subtitle', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6', 'heading7', 'admon-attention-hdr', 'admon-attention-body', 'admon-caution-hdr', 'admon-caution-body', 'admon-danger-hdr', 'admon-danger-body', 'admon-error-hdr', 'admon-error-body', 'admon-generic-hdr', 'admon-generic-body', 'admon-hint-hdr', 'admon-hint-body', 'admon-important-hdr', 'admon-important-body', 'admon-note-hdr', 'admon-note-body', 'admon-tip-hdr', 'admon-tip-body', 'admon-warning-hdr', 'admon-warning-body', 'tableoption', 'tableoption.%c', 'tableoption.%c%d', 'Table%d', 'Table%d.%c', 'Table%d.%c%d', 'lineblock1', 'lineblock2', 'lineblock3', 'lineblock4', 'lineblock5', 'lineblock6', 'image', 'figureframe')

get_str_stylesheet()

retrieve_styles(extension)

Retrieve the stylesheet from either a .xml file or from a .odt (zip) file. Return the content as a string.

extract_table_styles(styles_str)

get_property(stylenode)

add_doc_title()

find_first_text_p(el)

Search the generated doc and return the first <text:p> element.

attach_page_style(el)

Attach the default page style.

Create an automatic-style that refers to the current style of this element and that refers to the default page style.

rststyle(name, parameters=())

Returns the style name to use for the given style.

If parameters is given name must contain a matching number of % and is used as a format expression with parameters as the value.

generate_content_element(root)

setup_page()

get_dom_stylesheet()

setup_paper(root_el)

add_header_footer(root_el)

code_none = 0

code_field = 1

code_text = 2

field_pat = re.compile('%(..?)%')

create_custom_headfoot(parent, text, style_name, automatic_styles)

make_field_element(parent, text, style_name, automatic_styles)

split_field_specifiers_iter(text)

astext()

content_astext()

set_title(title)

get_title()

set_embedded_file_list(embedded_file_list)

get_embedded_file_list()

get_meta_dict()

process_footnotes()

append_child(tag, attrib=None, parent=None)

append_p(style, text=None)

append_pending_ids(el)

set_current_element(el)

set_to_parent()

generate_labeled_block(node, label)

generate_labeled_line(node, label)

encode(text)

dispatch_visit(node)

Override to catch basic attributes which many nodes have.

handle_basic_atts(node)

default_visit(node)

Override for generic, uniform traversals.

default_departure(node)

Override for generic, uniform traversals.

visit_Text(node)

depart_Text(node)

visit_address(node)

depart_address(node)

visit_author(node)

depart_author(node)

visit_authors(node)

depart_authors(node)

visit_contact(node)

depart_contact(node)

visit_copyright(node)

depart_copyright(node)

visit_date(node)

depart_date(node)

visit_organization(node)

depart_organization(node)

visit_status(node)

depart_status(node)

visit_revision(node)

depart_revision(node)

visit_version(node)

depart_version(node)

visit_attribution(node)

depart_attribution(node)

visit_block_quote(node)

depart_block_quote(node)

visit_bullet_list(node)

depart_bullet_list(node)

visit_caption(node)

depart_caption(node)

visit_comment(node)

depart_comment(node)

visit_compound(node)

depart_compound(node)

visit_container(node)

depart_container(node)

visit_decoration(node)

depart_decoration(node)

visit_definition_list(node)

depart_definition_list(node)

visit_definition_list_item(node)

depart_definition_list_item(node)

visit_term(node)

depart_term(node)

visit_definition(node)

depart_definition(node)

visit_classifier(node)

depart_classifier(node)

visit_document(node)

depart_document(node)

visit_docinfo(node)

depart_docinfo(node)

visit_emphasis(node)

depart_emphasis(node)

visit_enumerated_list(node)

depart_enumerated_list(node)

visit_list_item(node)

depart_list_item(node)

visit_header(node)

depart_header(node)

visit_footer(node)

depart_footer(node)

visit_field(node)

depart_field(node)

visit_field_list(node)

depart_field_list(node)

visit_field_name(node)

depart_field_name(node)

visit_field_body(node)

depart_field_body(node)

visit_figure(node)

depart_figure(node)

visit_footnote(node)

depart_footnote(node)

footnote_chars = ['*', '**', '***', '++', '+++', '##', '###', '@@', '@@@']

visit_footnote_reference(node)

depart_footnote_reference(node)

visit_citation(node)

depart_citation(node)

visit_citation_reference(node)

depart_citation_reference(node)

visit_label(node)

depart_label(node)

visit_generated(node)

depart_generated(node)

check_file_exists(path)

visit_image(node)

depart_image(node)

get_image_width_height(node, attr)

convert_to_cm(size)

Convert various units to centimeters.

Note that a call to this method should be wrapped in:

try: except ValueError:

get_image_scale(node)

get_image_scaled_width_height(node, source)

Return the image size in centimeters adjusted by image attrs.

get_page_width()

Return the document’s page width in centimeters.

generate_figure(node, source, destination, current_element)

generate_image(node, source, destination, current_element, frame_attrs=None)

is_in_table(node)

visit_legend(node)

depart_legend(node)

visit_line_block(node)

depart_line_block(node)

visit_line(node)

depart_line(node)

visit_literal(node)

depart_literal(node)

visit_inline(node)

depart_inline(node)

_calculate_code_block_padding(line)

_add_syntax_highlighting(insource, language)

fill_line(line)

fill_func1(matchobj)

fill_func2(matchobj)

visit_literal_block(node)

depart_literal_block(node)

visit_doctest_block(node)

depart_doctest_block(node)

visit_math(node)

depart_math(node)

visit_math_block(node)

depart_math_block(node)

visit_meta(node)

depart_meta(node)

visit_option_list(node)

depart_option_list(node)

visit_option_list_item(node)

depart_option_list_item(node)

visit_option_group(node)

depart_option_group(node)

visit_option(node)

depart_option(node)

visit_option_string(node)

depart_option_string(node)

visit_option_argument(node)

depart_option_argument(node)

visit_description(node)

depart_description(node)

visit_paragraph(node)

depart_paragraph(node)

visit_problematic(node)

depart_problematic(node)

visit_raw(node)

depart_raw(node)

visit_reference(node)

depart_reference(node)

visit_rubric(node)

depart_rubric(node)

visit_section(node, move_ids=1)

depart_section(node)

visit_strong(node)

depart_strong(node)

visit_substitution_definition(node)

depart_substitution_definition(node)

visit_system_message(node)

depart_system_message(node)

get_table_style(node)

visit_table(node)

depart_table(node)

visit_tgroup(node)

depart_tgroup(node)

visit_colspec(node)

depart_colspec(node)

visit_thead(node)

depart_thead(node)

visit_row(node)

depart_row(node)

visit_entry(node)

depart_entry(node)

visit_tbody(node)

depart_tbody(node)

visit_target(node)

depart_target(node)

visit_title(node, move_ids=1, title_type='title')

depart_title(node)

visit_subtitle(node, move_ids=1)

depart_subtitle(node)

visit_title_reference(node)

depart_title_reference(node)

generate_table_of_content_entry_template(el1)

find_title_label(node, class_type, label_key)

visit_topic(node)

depart_topic(node)

update_toc_page_numbers(el)

update_toc_collect(el, level, collection)

update_toc_add_numbers(collection)

visit_transition(node)

depart_transition(node)

visit_warning(node)

depart_warning(node)

visit_attention(node)

depart_attention(node)

visit_caution(node)

depart_caution(node)

visit_danger(node)

depart_danger(node)

visit_error(node)

depart_error(node)

visit_hint(node)

depart_hint(node)

visit_important(node)

depart_important(node)

visit_note(node)

depart_note(node)

visit_tip(node)

depart_tip(node)

visit_admonition(node)

depart_admonition(node)

generate_admonition(node, label, title=None)

visit_subscript(node)

depart_subscript(node)

visit_superscript(node)

depart_superscript(node)

visit_abbreviation(node)

depart_abbreviation(node)

visit_acronym(node)

depart_acronym(node)

visit_sidebar(node)

depart_sidebar(node)

class Reader(parser=None, parser_name=None)

Bases: Reader

get_transforms()

Transforms required by this class. Override in subclasses.

Submodules

• docutils.writers.odf_odt.prepstyles module
• docutils.writers.odf_odt.pygmentsformatter module