FileDumper.__flatten() - Code Metrics - Inspection of "Adds unit tests and improves code coverage" - csanquer/git-app-version - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 790092...745d04 )

by Charles

created 2016-12-23 00:02 UTC

FileDumper.__flatten() A

↳ Parent: FileDumper

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	8.6667

Importance

Changes

Metric	Value
cc	3
dl	0
loc	8
ccs	1
cts	7
cp	0.1429
crap	8.6667
rs	9.4285
c	0
b	0
f	0

# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

import os
import json

import xmltodict
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from git_app_version.helper.pyversion import PY3

try:
    import ConfigParser as configparser
except ImportError:
    import configparser

import yaml
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3


class FileDumper(object):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    def dump(
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            self,
            data=None,
            fileformat='json',
            target=None,
            cwd=None,
            namespace=''):
        target = self.__check_target(target, cwd)
        if fileformat == 'yaml' or fileformat == 'yml':
            return self.dump_yaml(data, target, namespace)
        elif fileformat == 'xml':
            return self.dump_xml(data, target, namespace)
        elif fileformat == 'ini':
            return self.dump_ini(data, target, namespace)
        else:
            return self.dump_json(data, target, namespace)

    def __check_target(self, target, cwd=None):
        if not os.path.isabs(target):
            cwd = cwd if cwd else os.getcwd()
            target = cwd + '/' + target

        self.__make_parent_dir(target)

        return target

    def __make_parent_dir(self, target):
class Foo:
    def some_method(self, x, y):
        return x + y;
        parent_dir = os.path.dirname(target)
        if not os.path.exists(parent_dir):
            os.makedirs(parent_dir, 493)  # 493 in decimal as 755 in octal

    def __create_infos_to_dump(self, infos, namespace=None):
class Foo:
    def some_method(self, x, y):
        return x + y;
        to_dump = infos
        if namespace is not None and namespace != '':
            namespaces = namespace.split('.')
            namespaces.reverse()
            for name in namespaces:
                to_dump = {name: to_dump}

        return to_dump

    def __encode(self, item, encoding='utf-8'):
class Foo:
    def some_method(self, x, y):
        return x + y;
        if isinstance(item, unicode):

            return item.encode(encoding)
        else:
            return item

    def __flatten(self, item):
class Foo:
    def some_method(self, x, y):
        return x + y;
        if isinstance(item, list):
            flattened_list = ''
            if len(item):
                flattened_list = "'{}'".format("', '".join(item))
            return "[{}]".format(flattened_list)
        else:
            return item

    def dump_ini(self, data, target, namespace=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        target = target + '.ini'
        namespace = 'app_version' if namespace is None or namespace == '' else namespace

        ini = configparser.RawConfigParser()
        ini.add_section(namespace)

        for key, val in data.items():
            if not PY3:
                val = self.__encode(self.__flatten(val))

            ini.set(namespace, key, val)

        with open(target, 'w') as fp:

            ini.write(fp)

        return target

    def dump_xml(self, data, target, namespace=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        target = target + '.xml'
        namespace = 'app_version' if namespace is None or namespace == '' else namespace

        with open(target, 'w') as fp:

            xml = xmltodict.unparse(
                self.__create_infos_to_dump(
                    data,
                    namespace),
                encoding='utf-8',
                pretty=True,
                indent='  ')
            if not PY3:
                xml = xml.encode('utf-8')

            fp.write(xml)

            return target

    def dump_json(self, data, target, namespace=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        target = target + '.json'

        data1 = self.__create_infos_to_dump(data, namespace)

        with open(target, 'w') as fp:

            json.dump(data1, fp, indent=2)

        return target

    def dump_yaml(self, data, target, namespace=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        target = target + '.yml'

        with open(target, 'w') as fp:

            if not data:
                fp.write("---\n")
            else:
                yaml.safe_dump(
                    self.__create_infos_to_dump(data, namespace),
                    fp,
                    default_flow_style=False,
                    explicit_start=True,
                    allow_unicode=True,
                    default_style='\''  # force quoting to prevent abbrev_commit to be read as a float

                )

        return target


1		# -- coding: utf-8 --
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 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
3	1	import os
4	1	import json
5
6	1	import xmltodict
		0 ignored issues – show Configuration introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report The import `xmltodict` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
7	1	from git_app_version.helper.pyversion import PY3
8
9	1	try:
10	1	import ConfigParser as configparser
11	1	except ImportError:
12	1	import configparser
13
14	1	import yaml
		0 ignored issues – show Configuration introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report The import `yaml` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
15
16
17	1	class FileDumper(object):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 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...
18
19	1	def dump(
		0 ignored issues – show Coding Style introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report This method 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... best-practice introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report Too many arguments (6/5) Loading history...
20		self,
21		data=None,
22		fileformat='json',
23		target=None,
24		cwd=None,
25		namespace=''):
26	1	target = self.__check_target(target, cwd)
27	1	if fileformat == 'yaml' or fileformat == 'yml':
28	1	return self.dump_yaml(data, target, namespace)
29	1	elif fileformat == 'xml':
30	1	return self.dump_xml(data, target, namespace)
31	1	elif fileformat == 'ini':
32	1	return self.dump_ini(data, target, namespace)
33		else:
34	1	return self.dump_json(data, target, namespace)
35
36	1	def __check_target(self, target, cwd=None):
37	1	if not os.path.isabs(target):
38	1	cwd = cwd if cwd else os.getcwd()
39	1	target = cwd + '/' + target
40
41	1	self.__make_parent_dir(target)
42
43	1	return target
44
45	1	def __make_parent_dir(self, target):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
46	1	parent_dir = os.path.dirname(target)
47	1	if not os.path.exists(parent_dir):
48	1	os.makedirs(parent_dir, 493) # 493 in decimal as 755 in octal
49
50	1	def __create_infos_to_dump(self, infos, namespace=None):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
51	1	to_dump = infos
52	1	if namespace is not None and namespace != '':
53	1	namespaces = namespace.split('.')
54	1	namespaces.reverse()
55	1	for name in namespaces:
56	1	to_dump = {name: to_dump}
57
58	1	return to_dump
59
60	1	def __encode(self, item, encoding='utf-8'):
		0 ignored issues – show Coding Style introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
61		if isinstance(item, unicode):
		1 ignored issue – show Comprehensibility Best Practice introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report Undefined variable 'unicode' Loading history...
62		return item.encode(encoding)
63		else:
64		return item
65
66	1	def __flatten(self, item):
		0 ignored issues – show Coding Style introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
67		if isinstance(item, list):
68		flattened_list = ''
69		if len(item):
70		flattened_list = "'{}'".format("', '".join(item))
71		return "[{}]".format(flattened_list)
72		else:
73		return item
74
75	1	def dump_ini(self, data, target, namespace=None):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method 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...
76	1	target = target + '.ini'
77	1	namespace = 'app_version' if namespace is None or namespace == '' else namespace
78
79	1	ini = configparser.RawConfigParser()
80	1	ini.add_section(namespace)
81
82	1	for key, val in data.items():
83	1	if not PY3:
84		val = self.__encode(self.__flatten(val))
85
86	1	ini.set(namespace, key, val)
87
88	1	with open(target, 'w') as fp:
		0 ignored issues – show Coding Style Naming introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report The name `fp` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
89	1	ini.write(fp)
90
91	1	return target
92
93	1	def dump_xml(self, data, target, namespace=None):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method 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...
94	1	target = target + '.xml'
95	1	namespace = 'app_version' if namespace is None or namespace == '' else namespace
96
97	1	with open(target, 'w') as fp:
		0 ignored issues – show Coding Style Naming introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report The name `fp` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
98	1	xml = xmltodict.unparse(
99		self.__create_infos_to_dump(
100		data,
101		namespace),
102		encoding='utf-8',
103		pretty=True,
104		indent=' ')
105	1	if not PY3:
106		xml = xml.encode('utf-8')
107
108	1	fp.write(xml)
109
110	1	return target
111
112	1	def dump_json(self, data, target, namespace=None):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method 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...
113	1	target = target + '.json'
114
115	1	data1 = self.__create_infos_to_dump(data, namespace)
116
117	1	with open(target, 'w') as fp:
		0 ignored issues – show Coding Style Naming introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report The name `fp` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
118	1	json.dump(data1, fp, indent=2)
119
120	1	return target
121
122	1	def dump_yaml(self, data, target, namespace=None):
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 UTC by Report Bug Copy Issue Report This method 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...
123	1	target = target + '.yml'
124
125	1	with open(target, 'w') as fp:
		0 ignored issues – show Coding Style Naming introduced 2016-12-22 17:45 UTC by Report Bug Copy Issue Report The name `fp` does not conform to the variable naming conventions (`[a-z_][a-z0-9_]{2,30}$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
126	1	if not data:
127	1	fp.write("---\n")
128		else:
129	1	yaml.safe_dump(
130		self.__create_infos_to_dump(data, namespace),
131		fp,
132		default_flow_style=False,
133		explicit_start=True,
134		allow_unicode=True,
135		default_style='\'' # force quoting to prevent abbrev_commit to be read as a float
		0 ignored issues – show Coding Style introduced 2016-06-24 15:06 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...
136		)
137
138		return target
139

Push — master ( 790092...745d04 )

FileDumper.__flatten() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

csanquer / git-app-version

Push — master ( 790092...745d04 )

FileDumper.__flatten() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files