sdoc.format.HtmlFormat

Complexity

Total Complexity

12

Size/Duplication

Total Lines	116
Duplicated Lines	90.52 %

Test Coverage

Coverage

82%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	HtmlFormat.generate()	28	28	5
A	HtmlFormat.enumerate()	6	6	1
A	HtmlFormat._read_configuration()	28	28	5
A	HtmlFormat.__init__()	31	31	1

import os
from configparser import ConfigParser

from cleo.io.io import IO

from sdoc import sdoc2
from sdoc.error import SDocError
from sdoc.format.Format import Format


class HtmlFormat(Format):

This code seems to be duplicated in your project.

    """
    Class for generating HTML
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, io: IO, target_format: str, config: ConfigParser):
        """
        Object constructor.

        :param OutputStyle io: The IO object.
        :param str target_format: The name of the format (in the config file).
        :param ConfigParser config: The section in the config file for the target_format.
        """
        Format.__init__(self, io)

        self._enumerate: bool = True
        """
        If set chapters, sections, etc. must be numbered.
        """

        self._file_per_chapter: bool = False
        """
        If set, will generate multiple .html files for each chapter.
        """

        self._one_file: bool = True
        """
        If set, will generate one .html file.
        """

        self._target_dir: str = '.'
        """
        The directory where the document in the target format must be created.
        """

        self._read_configuration(target_format, config)

    # ------------------------------------------------------------------------------------------------------------------
    def _read_configuration(self, target_format: str, config: ConfigParser) -> None:
        """
        Reads the configuration for this formatter.

        :param str target_format: The name of the format (in the config file).
        :param ConfigParser config: The section in the config file for the target_format.
        """
        section = 'format_' + target_format

        try:
            self._enumerate = config.getboolean(section, 'enumerate', fallback=self._enumerate)
        except ValueError:
            raise SDocError("Option 'enumerate' not set correctly")

        try:
            self._file_per_chapter = config.getboolean(section, 'file_per_chapter', fallback=self._file_per_chapter)
        except ValueError:
            raise SDocError("Option 'file_per_chapter' not set correctly")

        try:
            self._one_file = config.getboolean(section, 'one_file', fallback=self._one_file)
        except ValueError:
            raise SDocError("Option 'one_file' not set correctly")

        try:
            self._target_dir = config.get('sdoc', 'target_dir', fallback=self._target_dir)
        except ValueError:
            raise SDocError("Option 'target_dir' not set correctly")

    # ------------------------------------------------------------------------------------------------------------------
    @property
    def enumerate(self) -> bool:
        """
        Getter for enumerate attribute.
        """
        return self._enumerate

    # ------------------------------------------------------------------------------------------------------------------
    def generate(self) -> int:
        """
        Generating the document in HTML and returns the number of errors encountered.
        """
        # Activate numbering nodes.
        if self.enumerate:
            sdoc2.node_store.number_numerable()

        # Generate labels.
        sdoc2.node_store.parse_labels()

        # Generate table of contents.
        sdoc2.node_store.generate_toc()

        # Generate whole HTML output file.
        if self._one_file:
            file_name = os.path.join(self._target_dir, 'output.html')
            self._io.write_line('Writing <fso>{0!s}</fso>'.format(file_name))
            with open(file_name, 'wt', encoding='utf8') as general_file:
                formatter = sdoc2.node_store.create_formatter(self._io, 'document')
                formatter.generate(sdoc2.node_store.nodes[1], general_file)
                self._errors += formatter.errors

        # Generate in mode 'output file on each chapter'.
        if self._file_per_chapter:
            raise RuntimeError()

        return self._errors

# ----------------------------------------------------------------------------------------------------------------------