Dumper

Complexity

Total Complexity

35

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Test Coverage

Coverage

84.51%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	dumpJson()	0	9	2
B	__encode()	0	9	6
A	dumpYaml()	0	17	3
A	dumpXml()	0	12	4
A	__createInfosToDump()	0	9	4
A	__makeParentDir()	0	4	2
B	dump()	0	10	5
A	__checkTarget()	0	10	4
B	dumpIni()	0	17	5

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

This module should have a docstring.

import os
import json
import xmltodict

The import xmltodict could not be resolved.

from collections import Iterable

Unused Iterable imported from collections

try:
    import configparser
except ImportError:
    import ConfigParser as configparser

The import ConfigParser could not be resolved.

import yaml

The import yaml could not be resolved.

try:
    from yaml import CDumper as Dumper

Unused CDumper imported from yaml as Dumper

except ImportError:
    from yaml import Dumper

The import yaml could not be resolved.

Unused Dumper imported from yaml

from git_app_version.helper.pyversion import PY3

class Dumper(object):

class already defined line 15

This class should have a docstring.

    def dump(self, data = {}, format = 'json', target = None, cwd=None, namespace=''):

No space allowed around keyword argument assignment
def dump(self, data = {}, format = 'json', target = None, cwd=None, namespace=''):
^

No space allowed around keyword argument assignment
def dump(self, data = {}, format = 'json', target = None, cwd=None, namespace=''):
^

No space allowed around keyword argument assignment
def dump(self, data = {}, format = 'json', target = None, cwd=None, namespace=''):
^

The default value {} might cause unintended side-effects.

This method should have a docstring.

This seems to re-define the built-in format.

Too many arguments (6/5)

        target = self.__checkTarget(target, cwd)
        if format == 'yaml' or format == 'yml':
            return self.dumpYaml(data, target, namespace)
        elif format == 'xml':
            return self.dumpXml(data, target, namespace)
        elif format == 'ini':
            return self.dumpIni(data, target, namespace)
        else:
            return self.dumpJson(data, target, namespace)

    def __checkTarget(self, target, cwd=None):

The name __checkTarget does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

        if not os.path.isabs(target):
            if cwd is None or not os.path.exists(cwd):
                cwd = os.getcwd()

            target = cwd+'/'+target

        self.__makeParentDir(target)

        return target

    def __makeParentDir(self, target):

The name __makeParentDir does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method could be written as a function/class method.

        parentDir = os.path.dirname(target)

The name parentDir does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

        if not os.path.exists(parentDir):
            os.makedirs(parentDir, 493) # 493 in decimal as 755 in octal

    def __createInfosToDump(self, infos, namespace=None):

The name __createInfosToDump does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method could be written as a function/class method.

        toDump = infos

The name toDump does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

        if namespace is not None and namespace != '' :

No space allowed before :
if namespace is not None and namespace != '' :
^

            namespaces = namespace.split('.')
            namespaces.reverse()
            for name in namespaces :

No space allowed before :
for name in namespaces :
^

                toDump = { name: toDump }

No space allowed after bracket
toDump = name: toDump
^

No space allowed before bracket
toDump = name: toDump
^

The name toDump does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

        return toDump

    def __encode(self, input, encoding='utf-8'):

This seems to re-define the built-in input.

        if isinstance(input, dict):
            return {self.__encode(key, encoding): self.__encode(value, encoding) for key, value in input.iteritems()}

This line is too long as per the coding-style (117/100).

        elif isinstance(input, list):
            return [self.__encode(element, encoding) for element in input]
        elif isinstance(input, unicode):

Undefined variable 'unicode'

            return input.encode(encoding)
        else:
            return input

    def dumpIni(self, data, target, namespace=None):

The name dumpIni does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method should have a docstring.

        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():

Exactly one space required after comma
for key,val in data.items():
^

            if PY3:
                ini.set(namespace, key, val)
            else:
                ini.set(namespace, key, self.__encode(val))

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

The name f does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            ini.write(f)

        return target

    def dumpXml(self, data, target, namespace=None):

The name dumpXml does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method should have a docstring.

        target = target+'.xml'
        namespace = 'app_version' if namespace is None or namespace == '' else namespace

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

The name f does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            xml = xmltodict.unparse(self.__createInfosToDump(data, namespace), encoding='utf-8', pretty=True, indent='  ')

This line is too long as per the coding-style (122/100).

            if PY3:
                f.write(xml)
            else:
                f.write(xml.encode('utf-8'))

            return target

    def dumpJson(self, data, target, namespace=None):

The name dumpJson does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method should have a docstring.

        target = target+'.json'

        data1 = self.__createInfosToDump(data, namespace)

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

The name f does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

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

        return target

    def dumpYaml(self, data, target, namespace=None):

The name dumpYaml does not conform to the method naming conventions ([a-z_][a-z0-9_]{2,30}$).

This method should have a docstring.

        target = target+'.yml'

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

The name f does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            if not data :

No space allowed before :
if not data :
^

                f.write("---\n")
            else :

No space allowed before :
else :
^

                yaml.safe_dump(
                    self.__createInfosToDump(data, namespace),
                    f,
                    default_flow_style=False,
                    explicit_start=True,
                    allow_unicode=True,
                    default_style='\'' # force quoting to prevent abbrev_commit to be read as a float

This line is too long as per the coding-style (101/100).

                )

        return target