sdoc.sdoc2.formatter.Formatter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	89.77 %

Test Coverage

Coverage

96.88%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	Formatter.generate()	14	14	2
A	Formatter.error()	19	19	3
A	Formatter.errors()	11	11	2
A	Formatter.__init__()	21	21	1

from typing import Any, Optional

from cleo.io.io import IO

from sdoc.sdoc2 import in_scope, node_store, out_scope
from sdoc.sdoc2.node.Node import Node


class Formatter:

This code seems to be duplicated in your project.

    """
    Abstract parent class for all formatters for generating the output of nodes in a requested format.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, io: IO, parent):
        """
        Object constructor.

        :param OutputStyle io: The IO object.
        :param sdoc.sdoc2.formatter.Formatter.Formatter|None parent: The formatter for the parent node.
        """
        self._io: IO = io
        """
        The IO object.
        """

        self._parent = parent
        """
        The formatter for the parent node.

        :type: sdoc.sdoc2.formatter.Formatter.Formatter
        """

        self._errors: int = 0
        """
        The error count.
        """

    # ------------------------------------------------------------------------------------------------------------------
    @property
    def errors(self) -> int:
        """
        Getter for the error count.

        :rtype: int
        """
        if self._parent:
            return self._parent.errors

        return self._errors

    # ------------------------------------------------------------------------------------------------------------------
    def error(self, message: str, node: Optional[Node] = None) -> None:
        """
        Logs an error.

        :param str message: The error message. This message will be appended with 'at filename:line.column' ot the token.
        :param Node node: The node where the error occurred.
        """
        if self._parent:
            self._parent.error(message, node)
        else:
            self._errors += 1

            messages = [message]
            if node:
                filename = node.position.file_name
                line_number = node.position.start_line
                column_number = node.position.start_column + 1
                messages.append('Position: {0!s}:{1:d}.{2:d}'.format(filename, line_number, column_number))
            self._io.write_error(messages)

    # ------------------------------------------------------------------------------------------------------------------
    def generate(self, node: Node, file: Any) -> None:
        """
        Generates the representation of a node in the requested output format.

        :param Node node: The node for which the output must be generated.
        :param any file: The output file.
        """
        for node_id in node.child_nodes:
            child_node = in_scope(node_id)

            formatter = node_store.create_formatter(self._io, child_node.get_command(), self)
            formatter.generate(child_node, file)

            out_scope(child_node)

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