oval_graph.command_line.arf_to_report() - Code Metrics - Inspection of "[WIP] New command arf-to-report" - OpenSCAP/oval-graph - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#149)

by Jan

created 2021-03-24 17:52 UTC

oval_graph.command_line.arf_to_report() A

↳ Parent: oval_graph.command_line

Complexity

Conditions

Size

Total Lines	6
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	4.3145

Importance

Changes

Metric	Value
cc	2
eloc	6
nop	1
dl	0
loc	6
ccs	1
cts	6
cp	0.1666
crap	4.3145
rs	10
c	0
b	0
f	0

import sys

import traceback

from .command_line_client.arf_to_html import ArfToHtml
from .command_line_client.arf_to_html_report import ArfToHtmlReport
from .command_line_client.arf_to_json import ArfToJson
from .command_line_client.json_to_html import JsonToHtml

CRED = '\033[91m'
CEND = '\033[0m'


def print_where_is_saved_result(results_src):

    if results_src:
        print("Results are saved:", file=sys.stderr)
        for src in results_src:
            print(src, file=sys.stderr)


def print_detail_traceback_if_verbose(args):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    if any(arg in args for arg in ("-v", "--verbose")):
        traceback.print_exc()


def arf_to_report(args=None):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    try:
        main(ArfToHtmlReport(args))
    except Exception as error:

        print_detail_traceback_if_verbose(args)
        print((CRED + 'Error: {}' + CEND).format(error))


def arf_to_graph(args=None):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    try:
        main(ArfToHtml(args))
    except Exception as error:

        print_detail_traceback_if_verbose(args)
        print((CRED + 'Error: {}' + CEND).format(error))


def arf_to_json(args=None):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    try:
        main(ArfToJson(args))
    except Exception as error:

        print_detail_traceback_if_verbose(args)
        print((CRED + 'Error: {}' + CEND).format(error))


def json_to_graph(args=None):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    try:
        main(JsonToHtml(args))
    except Exception as error:

        print_detail_traceback_if_verbose(args)
        print((CRED + 'Error: {}' + CEND).format(error))


def main(client):

    results_src = []
    rules = client.search_rules_id()
    if len(rules) > 1:
        answers = client.run_gui_and_return_answers()
        if answers is not None:
            results_src = client.prepare_data(answers)
    else:
        results_src = client.prepare_data({'rules': [rules[0]]})
    if client.arg.verbose:
        print_where_is_saved_result(results_src)


if __name__ == '__main__':
    import argparse

    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers()

    parser_arf_to_graph = subparsers.add_parser(
        'arf-to-graph', help='Executes the arf-to-graph command.')
    parser_arf_to_graph.set_defaults(command=arf_to_graph)

    parser_arf_to_json = subparsers.add_parser(
        'arf-to-json', help='Executes the arf-to-json command.')
    parser_arf_to_json.set_defaults(command=arf_to_json)

    parser_json_to_graph = subparsers.add_parser(
        'json-to-graph', help='Executes the json-to-graph command.')
    parser_json_to_graph.set_defaults(command=json_to_graph)

    parser_arf_to_report = subparsers.add_parser(
        'arf-to-report', help='Executes the arf-to-report command.')
    parser_arf_to_report.set_defaults(command=arf_to_report)

    args, command_args = parser.parse_known_args()
    args.command(command_args)


1	1	import sys
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2	1	import traceback
3
4	1	from .command_line_client.arf_to_html import ArfToHtml
5	1	from .command_line_client.arf_to_html_report import ArfToHtmlReport
6	1	from .command_line_client.arf_to_json import ArfToJson
7	1	from .command_line_client.json_to_html import JsonToHtml
8
9	1	CRED = '\033[91m'
10	1	CEND = '\033[0m'
11
12
13	1	def print_where_is_saved_result(results_src):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
14	1	if results_src:
15	1	print("Results are saved:", file=sys.stderr)
16	1	for src in results_src:
17	1	print(src, file=sys.stderr)
18
19
20	1	def print_detail_traceback_if_verbose(args):
		0 ignored issues – show Comprehensibility Bug introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report `args` is re-defining a name which is already available in the outer-scope (previously defined on line `92`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history... introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
21	1	if any(arg in args for arg in ("-v", "--verbose")):
22	1	traceback.print_exc()
23
24
25	1	def arf_to_report(args=None):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history... Comprehensibility Bug introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report `args` is re-defining a name which is already available in the outer-scope (previously defined on line `92`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
26		try:
27		main(ArfToHtmlReport(args))
28		except Exception as error:
		0 ignored issues – show Best Practice introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
29		print_detail_traceback_if_verbose(args)
30		print((CRED + 'Error: {}' + CEND).format(error))
31
32
33	1	def arf_to_graph(args=None):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history... Comprehensibility Bug introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report `args` is re-defining a name which is already available in the outer-scope (previously defined on line `92`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
34	1	try:
35	1	main(ArfToHtml(args))
36	1	except Exception as error:
		0 ignored issues – show Best Practice introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
37	1	print_detail_traceback_if_verbose(args)
38	1	print((CRED + 'Error: {}' + CEND).format(error))
39
40
41	1	def arf_to_json(args=None):
		0 ignored issues – show Comprehensibility Bug introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report `args` is re-defining a name which is already available in the outer-scope (previously defined on line `92`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history... introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
42	1	try:
43	1	main(ArfToJson(args))
44	1	except Exception as error:
		0 ignored issues – show Best Practice introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
45	1	print_detail_traceback_if_verbose(args)
46	1	print((CRED + 'Error: {}' + CEND).format(error))
47
48
49	1	def json_to_graph(args=None):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history... Comprehensibility Bug introduced 2020-12-21 18:45 UTC by Report Bug Copy Issue Report `args` is re-defining a name which is already available in the outer-scope (previously defined on line `92`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
50	1	try:
51	1	main(JsonToHtml(args))
52	1	except Exception as error:
		0 ignored issues – show Best Practice introduced 2020-12-21 18:45 UTC by Report Bug Copy Issue Report Catching very general exceptions such as `Exception` is usually not recommended. Generally, you would want to handle very specific errors in the exception handler. This ensure that you do not hide other types of errors which should be fixed. So, unless you specifically plan to handle any error, consider adding a more specific exception. Loading history...
53	1	print_detail_traceback_if_verbose(args)
54	1	print((CRED + 'Error: {}' + CEND).format(error))
55
56
57	1	def main(client):
		0 ignored issues – show introduced 2021-02-24 17:28 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
58	1	results_src = []
59	1	rules = client.search_rules_id()
60	1	if len(rules) > 1:
61	1	answers = client.run_gui_and_return_answers()
62	1	if answers is not None:
63	1	results_src = client.prepare_data(answers)
64		else:
65	1	results_src = client.prepare_data({'rules': [rules[0]]})
66	1	if client.arg.verbose:
67	1	print_where_is_saved_result(results_src)
68
69
70	1	if __name__ == '__main__':
71	1	import argparse
72
73	1	parser = argparse.ArgumentParser()
74	1	subparsers = parser.add_subparsers()
75
76	1	parser_arf_to_graph = subparsers.add_parser(
77		'arf-to-graph', help='Executes the arf-to-graph command.')
78	1	parser_arf_to_graph.set_defaults(command=arf_to_graph)
79
80	1	parser_arf_to_json = subparsers.add_parser(
81		'arf-to-json', help='Executes the arf-to-json command.')
82	1	parser_arf_to_json.set_defaults(command=arf_to_json)
83
84	1	parser_json_to_graph = subparsers.add_parser(
85		'json-to-graph', help='Executes the json-to-graph command.')
86	1	parser_json_to_graph.set_defaults(command=json_to_graph)
87
88	1	parser_arf_to_report = subparsers.add_parser(
89		'arf-to-report', help='Executes the arf-to-report command.')
90	1	parser_arf_to_report.set_defaults(command=arf_to_report)
91
92	1	args, command_args = parser.parse_known_args()
93		args.command(command_args)
94

OpenSCAP / oval-graph

Pull Request — master (#149)

oval_graph.command_line.arf_to_report() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like