Html.generate_attribute() - Code Metrics - Inspection of "Merge branch 'master' of github.com:SDoc/py-sdoc" - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (0442a2)

by P.R.

created 2016-06-15 13:01 UTC

Html.generate_attribute() F

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	59
rs	3.1234
cc	14

How to fix Long Method Complexity

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""


class Html:
    """
    Static class with helper functions for generating HTML code.
    """

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def escape(text, quote=True):
        """
        Returns a string with special characters converted to HTML entities.

        :param str text: The string with optionally special characters.
        :param bool quote: If true the quotation mark characters, both double quote (") and single quote (')
                           characters are also translated.

        :rtype: str
        """
        text = text.replace("&", "&amp;")  # Must be done first!
        text = text.replace("<", "&lt;")
        text = text.replace(">", "&gt;")
        if quote:
            text = text.replace('"', "&quot;")
            text = text.replace('\'', "&#x27;")

        return text

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def generate_attribute(name, value):
        """
        Returns a string proper conversion of special characters to HTML entities of an attribute of a HTML tag.

        :param str name: The name of the attribute.
        :param str value: The value of the attribute.

        :rtype: str
        """
        html = ''

        # Boolean attributes.
        if name in ('autofocus',
                    'checked',
                    'disabled',
                    'hidden',
                    'ismap',
                    'multiple',
                    'novalidate',
                    'readonly',
                    'required',
                    'selected',
                    'spellcheck'):
            if value:
                html += ' '
                html += name
                html += '="'
                html += name
                html += '"'

        # Annoying boolean attribute exceptions.
        elif name in ('draggable', 'contenteditable'):
            if value is not None:
                html += ' '
                html += name
                html += '="true"' if value else '="false"'

        elif name == 'autocomplete':
            if value is not None:
                html += ' '
                html += name
                html += '="on"' if value else '="off"'

        elif name == 'translate':
            if value is not None:
                html += ' '
                html += name
                html += '="yes"' if value else '="no"'

        else:
            if value is not None and value != '':
                html += ' '
                html += Html.escape(name)
                html += '="'
                html += Html.escape(value)
                html += '"'

        return html

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def generate_element(tag_name, attributes=None, inner_text='', is_html=False):
        """
        Generates HTML code for an element.

        Note: tags for void elements such as '<br/>' are not supported.

        :param str tag_name: The name of the tag, e.g. a, form.
        :param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
                                         replaced with HTML entities.
        :param str inner_text: The inner text of the tag.
        :param bool is_html: If set the inner text is a HTML snippet, otherwise special characters in the inner text
                             will be replaced with HTML entities.

        :rtype: str
        """
        html = Html.generate_tag(tag_name, attributes)
        html += inner_text if is_html else Html.escape(inner_text)
        html += '</'
        html += tag_name
        html += '>'

        return html

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def generate_tag(tag_name, attributes=None):
        """
        Generates HTML code for a start tag of an element.

        :param str tag_name: The name of the tag, e.g. a, form.
        :param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
                                         replaced with HTML entities.

        :rtype: str
        """
        html = '<'
        html += tag_name
        for key in sorted(attributes):
            html += Html.generate_attribute(key, attributes[key])
        html += '>'

        return html

    # ------------------------------------------------------------------------------------------------------------------
    @staticmethod
    def generate_void_element(tag_name, attributes=None):
        """
        Generates HTML code for an element.

        Note: tags for void elements such as '<br/>' are not supported.

        :param str tag_name: The name of the tag, e.g. a, form.
        :param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
                                         replaced with HTML entities.

        :rtype: str
        """
        html = '<'
        html += tag_name
        for key in sorted(attributes):
            html += Html.generate_attribute(key, attributes[key])
        html += '/>'

        return html

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


1			"""
2			SDoc
3
4			Copyright 2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8
9
10			class Html:
11			"""
12			Static class with helper functions for generating HTML code.
13			"""
14
15			# ------------------------------------------------------------------------------------------------------------------
16			@staticmethod
17			def escape(text, quote=True):
18			"""
19			Returns a string with special characters converted to HTML entities.
20
21			:param str text: The string with optionally special characters.
22			:param bool quote: If true the quotation mark characters, both double quote (") and single quote (')
23			characters are also translated.
24
25			:rtype: str
26			"""
27			text = text.replace("&", "&") # Must be done first!
28			text = text.replace("<", "<")
29			text = text.replace(">", ">")
30			if quote:
31			text = text.replace('"', """)
32			text = text.replace('\'', "'")
33
34			return text
35
36			# ------------------------------------------------------------------------------------------------------------------
37			@staticmethod
38			def generate_attribute(name, value):
39			"""
40			Returns a string proper conversion of special characters to HTML entities of an attribute of a HTML tag.
41
42			:param str name: The name of the attribute.
43			:param str value: The value of the attribute.
44
45			:rtype: str
46			"""
47			html = ''
48
49			# Boolean attributes.
50			if name in ('autofocus',
51			'checked',
52			'disabled',
53			'hidden',
54			'ismap',
55			'multiple',
56			'novalidate',
57			'readonly',
58			'required',
59			'selected',
60			'spellcheck'):
61			if value:
62			html += ' '
63			html += name
64			html += '="'
65			html += name
66			html += '"'
67
68			# Annoying boolean attribute exceptions.
69			elif name in ('draggable', 'contenteditable'):
70			if value is not None:
71			html += ' '
72			html += name
73			html += '="true"' if value else '="false"'
74
75			elif name == 'autocomplete':
76			if value is not None:
77			html += ' '
78			html += name
79			html += '="on"' if value else '="off"'
80
81			elif name == 'translate':
82			if value is not None:
83			html += ' '
84			html += name
85			html += '="yes"' if value else '="no"'
86
87			else:
88			if value is not None and value != '':
89			html += ' '
90			html += Html.escape(name)
91			html += '="'
92			html += Html.escape(value)
93			html += '"'
94
95			return html
96
97			# ------------------------------------------------------------------------------------------------------------------
98			@staticmethod
99			def generate_element(tag_name, attributes=None, inner_text='', is_html=False):
100			"""
101			Generates HTML code for an element.
102
103			Note: tags for void elements such as '<br/>' are not supported.
104
105			:param str tag_name: The name of the tag, e.g. a, form.
106			:param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
107			replaced with HTML entities.
108			:param str inner_text: The inner text of the tag.
109			:param bool is_html: If set the inner text is a HTML snippet, otherwise special characters in the inner text
110			will be replaced with HTML entities.
111
112			:rtype: str
113			"""
114			html = Html.generate_tag(tag_name, attributes)
115			html += inner_text if is_html else Html.escape(inner_text)
116			html += '</'
117			html += tag_name
118			html += '>'
119
120			return html
121
122			# ------------------------------------------------------------------------------------------------------------------
123			@staticmethod
124			def generate_tag(tag_name, attributes=None):
125			"""
126			Generates HTML code for a start tag of an element.
127
128			:param str tag_name: The name of the tag, e.g. a, form.
129			:param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
130			replaced with HTML entities.
131
132			:rtype: str
133			"""
134			html = '<'
135			html += tag_name
136			for key in sorted(attributes):
137			html += Html.generate_attribute(key, attributes[key])
138			html += '>'
139
140			return html
141
142			# ------------------------------------------------------------------------------------------------------------------
143			@staticmethod
144			def generate_void_element(tag_name, attributes=None):
145			"""
146			Generates HTML code for an element.
147
148			Note: tags for void elements such as '<br/>' are not supported.
149
150			:param str tag_name: The name of the tag, e.g. a, form.
151			:param dict[str,str] attributes: The attributes of the tag. Special characters in the attributes will be
152			replaced with HTML entities.
153
154			:rtype: str
155			"""
156			html = '<'
157			html += tag_name
158			for key in sorted(attributes):
159			html += Html.generate_attribute(key, attributes[key])
160			html += '/>'
161
162			return html
163
164			# ----------------------------------------------------------------------------------------------------------------------
165

SDoc / py-sdoc

Branch — master (0442a2)

Html.generate_attribute() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like