PartHtmlFormatter

Complexity

Total Complexity

3

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

33.33%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	generate_part_node()	0	14	2
A	generate()	0	9	1

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""
# ----------------------------------------------------------------------------------------------------------------------
import os

The import os seems to be unused.

from sdoc.helper.Html import Html
from sdoc.sdoc2 import node_store
from sdoc.sdoc2.formatter.html.HtmlFormatter import HtmlFormatter


class PartHtmlFormatter(HtmlFormatter):
    """
    HtmlFormatter for generating HTML code for parts.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def generate(self, node, file):
        """
        Generates the HTML code for a part node.

        :param sdoc.sdoc2.node.HeadingNode.HeadingNode node: The heading node.
        :param file file: The output file.
        """
        self.generate_part_node(node, file)
        super().generate(node, file)

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def generate_part_node(node, file):
        """
        Generates the HTML code for part node.

        :param sdoc.sdoc2.node.HeadingNode.HeadingNode node: The heading node.
        :param file file: The output file.
        """
        # Set id attribute to heading node.
        attributes = {'id': node.get_option_value('id'), 'class': 'part'}

        number = node.get_option_value('number')
        text_in_tag = '{0} {1!s}'.format('' if not number else number, node.argument)
        file.write(Html.generate_element('div', attributes, text_in_tag))

# ----------------------------------------------------------------------------------------------------------------------
node_store.register_formatter('part', 'html', PartHtmlFormatter)