FileDumper.dump_sh() - Code Metrics - Inspection of "adds Shell script variables dump format" - csanquer/git-app-version - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d5feb1...7c9762 )

by Charles

created 2017-02-04 15:20 UTC

FileDumper.dump_sh() A

↳ Parent: FileDumper

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
dl	0
loc	10
ccs	8
cts	8
cp	1
crap	4
rs	9.2
c	0
b	0
f	0

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

import json
import os

import xmltodict
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import yaml
# .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


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)
        elif fileformat == 'sh':
            return self.dump_sh(data, target)
        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_sh(self, data, target):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        target = target + '.sh'

        with open(target, 'w') as fpt:
            for key, val in data.items():
                if not PY3:
                    val = self.__encode(self.__flatten(val))
                fpt.write("{}=\"{}\"\n".format(key, val))

        return target

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

        if namespace is None or namespace == '':
            namespace = 'app_version'

        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 fpt:
            ini.write(fpt)

        return target

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

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

            fpt.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 fpt:
            json.dump(data1, fpt, 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 fpt:
            if not data:
                fpt.write("---\n")
            else:
                yaml.safe_dump(
                    self.__create_infos_to_dump(data, namespace),
                    fpt,
                    default_flow_style=False,
                    explicit_start=True,
                    allow_unicode=True,
                    # force quoting
                    # to prevent abbrev_commit to be read as a float
                    default_style='\''
                )

        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 json
4	1	import os
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	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...
8
9	1	from git_app_version.helper.pyversion import PY3
10
11	1	try:
12	1	import ConfigParser as configparser
13		except ImportError:
14		import configparser
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	1	elif fileformat == 'sh':
34	1	return self.dump_sh(data, target)
35		else:
36	1	return self.dump_json(data, target, namespace)
37
38	1	def __check_target(self, target, cwd=None):
39	1	if not os.path.isabs(target):
40	1	cwd = cwd if cwd else os.getcwd()
41	1	target = cwd + '/' + target
42
43	1	self.__make_parent_dir(target)
44
45	1	return target
46
47	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...
48	1	parent_dir = os.path.dirname(target)
49	1	if not os.path.exists(parent_dir):
50	1	os.makedirs(parent_dir, 493) # 493 in decimal as 755 in octal
51
52	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...
53	1	to_dump = infos
54	1	if namespace is not None and namespace != '':
55	1	namespaces = namespace.split('.')
56	1	namespaces.reverse()
57	1	for name in namespaces:
58	1	to_dump = {name: to_dump}
59
60	1	return to_dump
61
62	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...
63	1	if isinstance(item, unicode):
64	1	return item.encode(encoding)
65		else:
66	1	return item
67
68	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...
69	1	if isinstance(item, list):
70	1	flattened_list = ''
71	1	if len(item):
72	1	flattened_list = "'{}'".format("', '".join(item))
73	1	return "[{}]".format(flattened_list)
74		else:
75	1	return item
76
77	1	def dump_sh(self, data, target):
		0 ignored issues – show Coding Style introduced 2017-02-04 15:22 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...
78	1	target = target + '.sh'
79
80	1	with open(target, 'w') as fpt:
81	1	for key, val in data.items():
82	1	if not PY3:
83	1	val = self.__encode(self.__flatten(val))
84	1	fpt.write("{}=\"{}\"\n".format(key, val))
85
86	1	return target
87
88	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...
89	1	target = target + '.ini'
90
91	1	if namespace is None or namespace == '':
92	1	namespace = 'app_version'
93
94	1	ini = configparser.RawConfigParser()
95	1	ini.add_section(namespace)
96
97	1	for key, val in data.items():
98	1	if not PY3:
99	1	val = self.__encode(self.__flatten(val))
100
101	1	ini.set(namespace, key, val)
102
103	1	with open(target, 'w') as fpt:
104	1	ini.write(fpt)
105
106	1	return target
107
108	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...
109	1	target = target + '.xml'
110	1	if namespace is None or namespace == '':
111	1	namespace = 'app_version'
112
113	1	with open(target, 'w') as fpt:
114	1	xml = xmltodict.unparse(
115		self.__create_infos_to_dump(
116		data,
117		namespace),
118		encoding='utf-8',
119		pretty=True,
120		indent=' ')
121	1	if not PY3:
122	1	xml = xml.encode('utf-8')
123
124	1	fpt.write(xml)
125
126	1	return target
127
128	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...
129	1	target = target + '.json'
130
131	1	data1 = self.__create_infos_to_dump(data, namespace)
132
133	1	with open(target, 'w') as fpt:
134	1	json.dump(data1, fpt, indent=2)
135
136	1	return target
137
138	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...
139	1	target = target + '.yml'
140
141	1	with open(target, 'w') as fpt:
142	1	if not data:
143	1	fpt.write("---\n")
144		else:
145	1	yaml.safe_dump(
146		self.__create_infos_to_dump(data, namespace),
147		fpt,
148		default_flow_style=False,
149		explicit_start=True,
150		allow_unicode=True,
151		# force quoting
152		# to prevent abbrev_commit to be read as a float
153		default_style='\''
154		)
155
156		return target
157

Push — master ( d5feb1...7c9762 )

FileDumper.dump_sh() 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 ( d5feb1...7c9762 )

FileDumper.dump_sh() 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