lighthouse_garden.export.render.render_items() - Code Metrics - Inspection of "5f3343b4cbaa38dcef6a6a18b29ad73b32a07c0a" - jackd248/lighthouse-garden - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (5f3343)

by Konrad

created 2021-01-10 17:34 UTC

lighthouse_garden.export.render.render_items() B

↳ Parent: lighthouse_garden.export.render

Complexity

Conditions

Size

Total Lines	70
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	48
dl	0
loc	70
rs	8.7018
c	0
b	0
f	0
cc	2
nop	0

How to fix Long Method

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

import datetime
import jinja2
import os

import sys


import lighthouse_garden
from lighthouse_garden import info
from lighthouse_garden.utility import output, system
from lighthouse_garden.lighthouse import database, utility

ASSETS_CSS = '/templates/assets/css'
ASSETS_JS = '/templates/assets/js'

TAG_CSS = 'style'
TAG_JS = 'script'


def generate_dashboard():

    _now = datetime.datetime.now()
    _file = f'{system.config["export_path"]}index.html'
    output.println(f'{output.Subject.INFO} Generating dashboard {output.CliFormat.BLACK}{_file}{output.CliFormat.ENDC}')


    html = open(_file, "w")

    _rendered_html = render_template('index.html.j2',
                                     logo=render_logo(),
                                     date=_now.strftime("%Y-%m-%dT%H:%M:%SZ"),
                                     assets_css=render_assets(ASSETS_CSS, TAG_CSS),
                                     assets_js=render_assets(ASSETS_JS, TAG_JS),
                                     items=render_items(),
                                     title=system.config['title'],
                                     description=system.config['description'],
                                     version=info.__version__,
                                     homepage=info.__homepage__,
                                     lighthouse_version=system.config['lighthouse']['version']
                                     )
    html.write(_rendered_html)
    html.close()


def render_items():

    _items = ''
    results = database.sort_by_average(
        database.get_last_results()
    )

    for result in results:
        _target = database.get_target_by_attribute(result['title'], 'title')
        _item = render_template('partials/item.html.j2',
                                title=result['title'],
                                url=result['url'],
                                last_report=result['report'],
                                identifier=_target['identifier'],
                                graph_values_y=','.join(map(str, database.get_history_by_attribute(
                                    _target, 'performance'))),
                                graph_values_x=','.join(map(str, database.get_history_by_attribute(
                                    _target, 'date'))),
                                graph_values_text=','.join(map(str, database.get_history_by_attribute(

                                    _target, 'report'))),
                                circle_average=render_percentage_circle(
                                    description=f'<strong>Average</strong><br/>'
                                                f'Calculates all available performance values to an average value.<br/><br/>'

                                                f'Maximum value: {int(result["average"]["max"])}<br/>'

                                                f'Minimum value: {int(result["average"]["min"])}<br/>',

                                    value=result['average']['value']
                                ),
                                circle_performance=render_percentage_circle(
                                    trend=render_trend(result),
                                    description=f'<strong>Performance</strong><br/>'

                                                f'The performance score is calculated directly from various metrics.<br/><br/>'

                                                f'Click here to get more information from the last report.',

                                    url=f'{result["report"]}#performance',
                                    value=result['performance']
                                ),
                                circle_accessibility=render_percentage_circle(
                                    description=f'<strong>Accessibility</strong><br/>'

                                                f'These checks highlight opportunities to improve the accessibility of '

                                                f'your web app.<br/><br/>'
                                                f'Click here to get more information from the last report.',

                                    value=result['accessibility'],
                                    url=f'{result["report"]}#accessibility',
                                    additional_class='small'
                                ),
                                circle_best_practices=render_percentage_circle(
                                    description=f'<strong>Best practices</strong><br/>'

                                                f'Further information about best practices.'
                                                f'See the lighthouse report for further information.<br/><br/>'

                                                f'Click here to get more information from the last report.',

                                    value=result['best-practices'],
                                    url=f'{result["report"]}#best-practices',
                                    additional_class='small'
                                ),
                                circle_seo=render_percentage_circle(
                                    description=f'<strong>SEO</strong><br/>'

                                                f'These checks ensure that your page is optimized for search engine '

                                                f'results ranking.<br/><br/>'
                                                f'Click here to get more information from the last report.',

                                    value=result['seo'],
                                    url=f'{result["report"]}#seo',
                                    additional_class='small'
                                ),
                                api_json=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.json',

                                badge_average=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.average.svg',

                                badge_performance=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.performance.svg',

                                badge_accessibility=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.accessibility.svg',

                                badge_best_practices=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.best-practices.svg',

                                badge_seo=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.seo.svg',

                                )
        _items += _item
    return _items


def render_percentage_circle(description, value, trend='', url='', additional_class=None):

    return render_template('partials/circle.html.j2',
                           url=url,
                           value=str(int(round(value))),
                           description=description,
                           color=get_percentage_classification(int(round(value))),
                           small=additional_class,
                           trend=trend
                           )


def render_trend(result):
    """

    :param result:
    :return:
    """
    _description = ''
    _class = ''
    if result['average']['trend'] == 1:
        _description = f'<strong>Performance trend</strong><br/>' \

                       f'Ascending trend in dependence of the last performance measurement to the average value.'

        _class = 'asc'
    elif result['average']['trend'] == -1:
        _description = f'<strong>Performance trend</strong><br/>' \

                       f'Descending trend in dependence of the last performance measurement to the average value.'

        _class = 'desc'

    if result['average']['trend'] == 0:

        return ''
    else:
        return render_template('partials/trend.html.j2',
                           description=_description,

                           trend=_class

                           )



def get_percentage_classification(value):

    if value >= 90:

        return 'green'
    elif value >= 50:
        return 'orange'
    else:
        return 'red'


def render_assets(path, tag):
    """

    :param path: String
    :param tag: String
    :return: String
    """
    _html = ''
    for file in os.listdir(os.path.dirname(lighthouse_garden.__file__) + path):
        with open(os.path.dirname(lighthouse_garden.__file__) + path + '/' + file, 'r') as read_file:

            _html += f'<!-- {file} -->\n<{tag}>\n{read_file.read()}\n</{tag}>\n'
    return _html


def render_logo():
    """

    :return:
    """
    with open(os.path.dirname(lighthouse_garden.__file__) + '/templates/assets/tower.svg', 'r') as read_file:

        return read_file.read()


def render_template(template, **args):
    """
    Render a template with jinja2
    :param template: String Template file
    :param args: Dictionary Template arguments
    :return: String Rendered Template
    """
    _template_loader = jinja2.FileSystemLoader(searchpath="./lighthouse_garden/templates/")
    _template_environment = jinja2.Environment(loader=_template_loader)
    _template = _template_environment.get_template(template)
    return _template.render(args)


1			#!/usr/bin/env python3
			0 ignored issues – show introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# -- coding: utf-8 --
3
4			import datetime
5			import jinja2
6			import os
			0 ignored issues – show introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report standard import "import os" should be placed before "import jinja2" Loading history...
7			import sys
			0 ignored issues – show Unused Code introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report The import `sys` seems to be unused. Loading history... introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report standard import "import sys" should be placed before "import jinja2" Loading history...
8
9			import lighthouse_garden
10			from lighthouse_garden import info
11			from lighthouse_garden.utility import output, system
12			from lighthouse_garden.lighthouse import database, utility
13
14			ASSETS_CSS = '/templates/assets/css'
15			ASSETS_JS = '/templates/assets/js'
16
17			TAG_CSS = 'style'
18			TAG_JS = 'script'
19
20
21			def generate_dashboard():
			0 ignored issues – show introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
22			_now = datetime.datetime.now()
23			_file = f'{system.config["export_path"]}index.html'
24			output.println(f'{output.Subject.INFO} Generating dashboard {output.CliFormat.BLACK}{_file}{output.CliFormat.ENDC}')
			0 ignored issues – show Coding Style introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (120/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
25
26			html = open(_file, "w")
27
28			_rendered_html = render_template('index.html.j2',
29			logo=render_logo(),
30			date=_now.strftime("%Y-%m-%dT%H:%M:%SZ"),
31			assets_css=render_assets(ASSETS_CSS, TAG_CSS),
32			assets_js=render_assets(ASSETS_JS, TAG_JS),
33			items=render_items(),
34			title=system.config['title'],
35			description=system.config['description'],
36			version=info.__version__,
37			homepage=info.__homepage__,
38			lighthouse_version=system.config['lighthouse']['version']
39			)
40			html.write(_rendered_html)
41			html.close()
42
43
44			def render_items():
			0 ignored issues – show introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
45			_items = ''
46			results = database.sort_by_average(
47			database.get_last_results()
48			)
49
50			for result in results:
51			_target = database.get_target_by_attribute(result['title'], 'title')
52			_item = render_template('partials/item.html.j2',
53			title=result['title'],
54			url=result['url'],
55			last_report=result['report'],
56			identifier=_target['identifier'],
57			graph_values_y=','.join(map(str, database.get_history_by_attribute(
58			_target, 'performance'))),
59			graph_values_x=','.join(map(str, database.get_history_by_attribute(
60			_target, 'date'))),
61			graph_values_text=','.join(map(str, database.get_history_by_attribute(
			0 ignored issues – show Coding Style introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (102/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
62			_target, 'report'))),
63			circle_average=render_percentage_circle(
64			description=f'<strong>Average</strong><br/>'
65			f'Calculates all available performance values to an average value.<br/><br/>'
			0 ignored issues – show Coding Style introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (125/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
66			f'Maximum value: {int(result["average"]["max"])}<br/>'
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (102/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
67			f'Minimum value: {int(result["average"]["min"])}<br/>',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (103/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
68			value=result['average']['value']
69			),
70			circle_performance=render_percentage_circle(
71			trend=render_trend(result),
72			description=f'<strong>Performance</strong><br/>'
			0 ignored issues – show introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
73			f'The performance score is calculated directly from various metrics.<br/><br/>'
			0 ignored issues – show Coding Style introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (127/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
74			f'Click here to get more information from the last report.',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
75			url=f'{result["report"]}#performance',
76			value=result['performance']
77			),
78			circle_accessibility=render_percentage_circle(
79			description=f'<strong>Accessibility</strong><br/>'
			0 ignored issues – show introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
80			f'These checks highlight opportunities to improve the accessibility of '
			0 ignored issues – show Coding Style introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (120/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
81			f'your web app.<br/><br/>'
82			f'Click here to get more information from the last report.',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
83			value=result['accessibility'],
84			url=f'{result["report"]}#accessibility',
85			additional_class='small'
86			),
87			circle_best_practices=render_percentage_circle(
88			description=f'<strong>Best practices</strong><br/>'
			0 ignored issues – show introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
89			f'Further information about best practices.'
90			f'See the lighthouse report for further information.<br/><br/>'
			0 ignored issues – show Coding Style introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (111/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
91			f'Click here to get more information from the last report.',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
92			value=result['best-practices'],
93			url=f'{result["report"]}#best-practices',
94			additional_class='small'
95			),
96			circle_seo=render_percentage_circle(
97			description=f'<strong>SEO</strong><br/>'
			0 ignored issues – show introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
98			f'These checks ensure that your page is optimized for search engine '
			0 ignored issues – show Coding Style introduced 2021-01-04 15:38 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (117/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
99			f'results ranking.<br/><br/>'
100			f'Click here to get more information from the last report.',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (108/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
101			value=result['seo'],
102			url=f'{result["report"]}#seo',
103			additional_class='small'
104			),
105			api_json=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.json',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (117/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
106			badge_average=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.average.svg',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (129/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
107			badge_performance=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.performance.svg',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (137/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
108			badge_accessibility=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.accessibility.svg',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (141/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
109			badge_best_practices=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.best-practices.svg',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (143/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
110			badge_seo=f'{utility.get_data_dir(absolute_path=False)}_{_target["identifier"]}.seo.svg',
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (121/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
111			)
112			_items += _item
113			return _items
114
115
116			def render_percentage_circle(description, value, trend='', url='', additional_class=None):
			0 ignored issues – show introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
117			return render_template('partials/circle.html.j2',
118			url=url,
119			value=str(int(round(value))),
120			description=description,
121			color=get_percentage_classification(int(round(value))),
122			small=additional_class,
123			trend=trend
124			)
125
126
127			def render_trend(result):
128			"""
129
130			:param result:
131			:return:
132			"""
133			_description = ''
134			_class = ''
135			if result['average']['trend'] == 1:
136			_description = f'<strong>Performance trend</strong><br/>' \
			0 ignored issues – show introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
137			f'Ascending trend in dependence of the last performance measurement to the average value.'
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (113/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
138			_class = 'asc'
139			elif result['average']['trend'] == -1:
140			_description = f'<strong>Performance trend</strong><br/>' \
			0 ignored issues – show introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Using an f-string that does not have any interpolated variables Loading history...
141			f'Descending trend in dependence of the last performance measurement to the average value.'
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (114/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
142			_class = 'desc'
143
144			if result['average']['trend'] == 0:
			0 ignored issues – show unused-code introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Unnecessary "else" after "return" Loading history...
145			return ''
146			else:
147			return render_template('partials/trend.html.j2',
148			description=_description,
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Wrong continued indentation (add 4 spaces). Loading history...
149			trend=_class
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Wrong continued indentation (add 4 spaces). Loading history...
150			)
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report Wrong continued indentation. Loading history...
151
152
153			def get_percentage_classification(value):
			0 ignored issues – show introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
154			if value >= 90:
			0 ignored issues – show unused-code introduced 2021-01-03 18:32 UTC by Report Bug Copy Issue Report Unnecessary "elif" after "return" Loading history...
155			return 'green'
156			elif value >= 50:
157			return 'orange'
158			else:
159			return 'red'
160
161
162			def render_assets(path, tag):
163			"""
164
165			:param path: String
166			:param tag: String
167			:return: String
168			"""
169			_html = ''
170			for file in os.listdir(os.path.dirname(lighthouse_garden.__file__) + path):
171			with open(os.path.dirname(lighthouse_garden.__file__) + path + '/' + file, 'r') as read_file:
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (101/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
172			_html += f'<!-- {file} -->\n<{tag}>\n{read_file.read()}\n</{tag}>\n'
173			return _html
174
175
176			def render_logo():
177			"""
178
179			:return:
180			"""
181			with open(os.path.dirname(lighthouse_garden.__file__) + '/templates/assets/tower.svg', 'r') as read_file:
			0 ignored issues – show Coding Style introduced 2021-01-10 17:35 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (109/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
182			return read_file.read()
183
184
185			def render_template(template, **args):
186			"""
187			Render a template with jinja2
188			:param template: String Template file
189			:param args: Dictionary Template arguments
190			:return: String Rendered Template
191			"""
192			_template_loader = jinja2.FileSystemLoader(searchpath="./lighthouse_garden/templates/")
193			_template_environment = jinja2.Environment(loader=_template_loader)
194			_template = _template_environment.get_template(template)
195			return _template.render(args)
196

jackd248 / lighthouse-garden

Branch — master (5f3343)

lighthouse_garden.export.render.render_items() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like