TableNode.prepare_content_tree() - Code Metrics - Inspection of "Merge pull request #28 from OlegKlimenko/sdoc-26" - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 57e7bf...8a74a7 )

by P.R.

created 2016-04-12 20:14 UTC

TableNode.prepare_content_tree() A

↳ Parent: TableNode

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	12
rs	9.4285
cc	2

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""
# ----------------------------------------------------------------------------------------------------------------------
import re
import csv
import io
from sdoc.sdoc2 import node_store, in_scope, out_scope
from sdoc.sdoc2.node.Node import Node


class TableNode(Node):
    """
    SDoc2 node for table.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, options):
        """
        Object constructor.

        :param dict[str,str] options: The options of this table.
        """
        super().__init__('table', options)

        self.rows = []
        """
        The table rows.

        :type: list[list[str]]
        """

        self.column_headers = []
        """
        The column headers of the table (if any).

        :type: list[str]
        """

        self.alignments = []
        """
        The text alignments in the table columns.

        :type: list[str|None]
        """

    # ------------------------------------------------------------------------------------------------------------------
    def get_command(self):
        """
        Returns the command of this node, i.e. table.

        :rtype: str
        """
        return 'table'

    # ------------------------------------------------------------------------------------------------------------------
    def is_block_command(self):
        """
        Returns True.

        :rtype: bool
        """
        return True

    # ------------------------------------------------------------------------------------------------------------------
    def is_inline_command(self):
        """
        Returns False.

        :rtype: bool
        """
        return False

    # ------------------------------------------------------------------------------------------------------------------
    def prepare_content_tree(self):
        """
        Prepares this node for further processing.
        """
        for node_id in self.child_nodes:
            node = in_scope(node_id)

            self.extract_table(node)

            node.prepare_content_tree()

            out_scope(node)

    # ------------------------------------------------------------------------------------------------------------------
    def extract_table(self, node):
        """
        Extract the table data from a TextNode.

        :param sdoc.sdoc2.node.Node.Node node: The node which may be interpreted as table.
        """
        temp_table_items = node.argument.split('\n')

        # Remove empty rows.
        while '' in temp_table_items:
            temp_table_items.remove('')

        # Derive table data.
        rows = []
        for item in temp_table_items:
            string = io.StringIO(item)
            reader = csv.reader(string, delimiter='|')
            for line in reader:
                row = line
                row = self.prune_whitespace(row)
                rows.append(row)

        if self.has_header(rows):
            self.column_headers = rows[0]
            self.rows = rows[2:]
            self.alignments = self.get_column_alignments(rows[1])
        else:
            self.rows = rows

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def has_header(row):
        """
        Returns True if the table has a table header.

        :param list[str] row: The second row of the table.

        :rtype: bool
        """
        is_header = True

        if len(row) == 1:
            return False

        for align in row[1]:
            header_part = re.findall(':?---+-*:?', align)
            if not header_part:
                is_header = False
                break

        return is_header

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def get_column_alignments(row):
        """
        Sets alignments on table columns.

        :param list[str] row: The row with hyphens for creating column headers.

        :rtype: list[str]
        """
        alignments = []
        for hyphens in row:
            hyphens = hyphens.strip()
            if hyphens.startswith(':') and hyphens.endswith(':'):
                alignments.append('center')
            elif hyphens.startswith(':'):
                alignments.append('left')
            elif hyphens.endswith(':'):
                alignments.append('right')
            else:
                alignments.append('')

        return alignments

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def prune_whitespace(row):
        """
        Strips whitespaces from the text of an each cell.

        :param list[str] row: The row with text of an each cell.
        :rtype: list[str]
        """
        clear_row = []
        for item in row:
            clear_text = item.strip()
            clear_text = re.sub(r'\s+', ' ', clear_text)
            clear_row.append(clear_text)

        return clear_row

# ----------------------------------------------------------------------------------------------------------------------
node_store.register_block_command('table', TableNode)


1			"""
2			SDoc
3
4			Copyright 2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			# ----------------------------------------------------------------------------------------------------------------------
9			import re
10			import csv
11			import io
12			from sdoc.sdoc2 import node_store, in_scope, out_scope
13			from sdoc.sdoc2.node.Node import Node
14
15
16			class TableNode(Node):
17			"""
18			SDoc2 node for table.
19			"""
20
21			# ------------------------------------------------------------------------------------------------------------------
22			def __init__(self, options):
23			"""
24			Object constructor.
25
26			:param dict[str,str] options: The options of this table.
27			"""
28			super().__init__('table', options)
29
30			self.rows = []
31			"""
32			The table rows.
33
34			:type: list[list[str]]
35			"""
36
37			self.column_headers = []
38			"""
39			The column headers of the table (if any).
40
41			:type: list[str]
42			"""
43
44			self.alignments = []
45			"""
46			The text alignments in the table columns.
47
48			:type: list[str\|None]
49			"""
50
51			# ------------------------------------------------------------------------------------------------------------------
52			def get_command(self):
53			"""
54			Returns the command of this node, i.e. table.
55
56			:rtype: str
57			"""
58			return 'table'
59
60			# ------------------------------------------------------------------------------------------------------------------
61			def is_block_command(self):
62			"""
63			Returns True.
64
65			:rtype: bool
66			"""
67			return True
68
69			# ------------------------------------------------------------------------------------------------------------------
70			def is_inline_command(self):
71			"""
72			Returns False.
73
74			:rtype: bool
75			"""
76			return False
77
78			# ------------------------------------------------------------------------------------------------------------------
79			def prepare_content_tree(self):
80			"""
81			Prepares this node for further processing.
82			"""
83			for node_id in self.child_nodes:
84			node = in_scope(node_id)
85
86			self.extract_table(node)
87
88			node.prepare_content_tree()
89
90			out_scope(node)
91
92			# ------------------------------------------------------------------------------------------------------------------
93			def extract_table(self, node):
94			"""
95			Extract the table data from a TextNode.
96
97			:param sdoc.sdoc2.node.Node.Node node: The node which may be interpreted as table.
98			"""
99			temp_table_items = node.argument.split('\n')
100
101			# Remove empty rows.
102			while '' in temp_table_items:
103			temp_table_items.remove('')
104
105			# Derive table data.
106			rows = []
107			for item in temp_table_items:
108			string = io.StringIO(item)
109			reader = csv.reader(string, delimiter='\|')
110			for line in reader:
111			row = line
112			row = self.prune_whitespace(row)
113			rows.append(row)
114
115			if self.has_header(rows):
116			self.column_headers = rows[0]
117			self.rows = rows[2:]
118			self.alignments = self.get_column_alignments(rows[1])
119			else:
120			self.rows = rows
121
122			# ------------------------------------------------------------------------------------------------------------------
123			@staticmethod
124			def has_header(row):
125			"""
126			Returns True if the table has a table header.
127
128			:param list[str] row: The second row of the table.
129
130			:rtype: bool
131			"""
132			is_header = True
133
134			if len(row) == 1:
135			return False
136
137			for align in row[1]:
138			header_part = re.findall(':?---+-*:?', align)
139			if not header_part:
140			is_header = False
141			break
142
143			return is_header
144
145			# ------------------------------------------------------------------------------------------------------------------
146			@staticmethod
147			def get_column_alignments(row):
148			"""
149			Sets alignments on table columns.
150
151			:param list[str] row: The row with hyphens for creating column headers.
152
153			:rtype: list[str]
154			"""
155			alignments = []
156			for hyphens in row:
157			hyphens = hyphens.strip()
158			if hyphens.startswith(':') and hyphens.endswith(':'):
159			alignments.append('center')
160			elif hyphens.startswith(':'):
161			alignments.append('left')
162			elif hyphens.endswith(':'):
163			alignments.append('right')
164			else:
165			alignments.append('')
166
167			return alignments
168
169			# ------------------------------------------------------------------------------------------------------------------
170			@staticmethod
171			def prune_whitespace(row):
172			"""
173			Strips whitespaces from the text of an each cell.
174
175			:param list[str] row: The row with text of an each cell.
176			:rtype: list[str]
177			"""
178			clear_row = []
179			for item in row:
180			clear_text = item.strip()
181			clear_text = re.sub(r'\s+', ' ', clear_text)
182			clear_row.append(clear_text)
183
184			return clear_row
185
186			# ----------------------------------------------------------------------------------------------------------------------
187			node_store.register_block_command('table', TableNode)
188

SDoc / py-sdoc

Push — master ( 57e7bf...8a74a7 )

TableNode.prepare_content_tree() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like