ssg.utils - Code Metrics - Inspection of "Merge pull request #3220 from cipherboy/platform-p..." - ComplianceAsCode/content - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8b9f7f...914492 )

by Marek

created 2018-09-23 22:50 UTC

ssg.utils A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

62.86%

Importance

Changes

Metric	Value
eloc	37
dl	0
loc	86
ccs	22
cts	35
cp	0.6286
rs	10
c	0
b	0
f	0
wmc	11

6 Functions

Rating	Name	Size	Complexity
A	get_cpu_count()	13	2
A	merge_dicts()	10	1
A	required_key()	11	2
A	subset_dict()	12	3
A	write_list_file()	10	1
A	read_file_list()	9	2

from __future__ import absolute_import
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
from __future__ import print_function

import multiprocessing


class SSGError(RuntimeError):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    pass


def required_key(_dict, _key):
    """
    Returns the value of _key if it is in _dict; otherwise, raise an
    exception stating that it was not found but is required.
    """

    if _key in _dict:
        return _dict[_key]

    raise ValueError("%s is required but was not found in:\n%s" %
                     (_key, repr(_dict)))


def get_cpu_count():
    """
    Returns the most likely estimate of the number of CPUs in the machine
    for threading purposes, gracefully handling errors and possible
    exceptions.
    """

    try:
        return max(1, multiprocessing.cpu_count())

    except NotImplementedError:
        # 2 CPUs is the most probable
        return 2


def merge_dicts(left, right):
    """
    Merges two dictionaries, keeing left and right as passed. If there are any
    common keys between left and right, the value from right is use.

    Returns the merger of the left and right dictionaries
    """
    result = left.copy()
    result.update(right)
    return result


def subset_dict(dictionary, keys):
    """
    Restricts dictionary to only have keys from keys. Does not modify either
    dictionary or keys, returning the result instead.
    """

    result = dictionary.copy()
    for original_key in dictionary:
        if original_key not in keys:
            del result[original_key]

    return result


def read_file_list(path):
    """
    Reads the given file path and returns the contents as a list.
    """

    file_contents = open(path, 'r').read().split("\n")
    if file_contents[-1] == '':
        file_contents = file_contents[:-1]
    return file_contents


def write_list_file(path, contents):
    """
    Writes the given contents to path.
    """

    _contents = "\n".join(contents) + "\n"
    _f = open(path, 'w')
    _f.write(_contents)
    _f.flush()
    _f.close()


1	2	from __future__ import absolute_import
		0 ignored issues – show Coding Style introduced 2018-06-22 19:05 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2	2	from __future__ import print_function
3
4	2	import multiprocessing
5
6
7	2	class SSGError(RuntimeError):
		0 ignored issues – show Coding Style introduced 2018-06-14 17:23 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
8	2	pass
9
10
11	2	def required_key(_dict, _key):
12		"""
13		Returns the value of _key if it is in _dict; otherwise, raise an
14		exception stating that it was not found but is required.
15		"""
16
17	2	if _key in _dict:
18	2	return _dict[_key]
19
20	2	raise ValueError("%s is required but was not found in:\n%s" %
21		(_key, repr(_dict)))
22
23
24	2	def get_cpu_count():
25		"""
26		Returns the most likely estimate of the number of CPUs in the machine
27		for threading purposes, gracefully handling errors and possible
28		exceptions.
29		"""
30
31		try:
32		return max(1, multiprocessing.cpu_count())
33
34		except NotImplementedError:
35		# 2 CPUs is the most probable
36		return 2
37
38
39	2	def merge_dicts(left, right):
40		"""
41		Merges two dictionaries, keeing left and right as passed. If there are any
42		common keys between left and right, the value from right is use.
43
44		Returns the merger of the left and right dictionaries
45		"""
46	2	result = left.copy()
47	2	result.update(right)
48	2	return result
49
50
51	2	def subset_dict(dictionary, keys):
52		"""
53		Restricts dictionary to only have keys from keys. Does not modify either
54		dictionary or keys, returning the result instead.
55		"""
56
57	2	result = dictionary.copy()
58	2	for original_key in dictionary:
59	2	if original_key not in keys:
60	2	del result[original_key]
61
62	2	return result
63
64
65	2	def read_file_list(path):
66		"""
67		Reads the given file path and returns the contents as a list.
68		"""
69
70		file_contents = open(path, 'r').read().split("\n")
71		if file_contents[-1] == '':
72		file_contents = file_contents[:-1]
73		return file_contents
74
75
76	2	def write_list_file(path, contents):
77		"""
78		Writes the given contents to path.
79		"""
80
81		_contents = "\n".join(contents) + "\n"
82		_f = open(path, 'w')
83		_f.write(_contents)
84		_f.flush()
85		_f.close()
86

ComplianceAsCode / content

Push — master ( 8b9f7f...914492 )

ssg.utils A

Complexity

Size/Duplication

Test Coverage

Importance

6 Functions

Duplication Side-by-Side

Filter issues like