LocalizedValue._interpret_value() - Code Metrics - Inspection of "Fix support for ArrayAgg" - SectorLabs/django-localized-fields - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0fa79d...5a4f44 )

by Swen

created 2017-05-25 16:23 UTC

LocalizedValue._interpret_value() C

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	7

Importance

Changes

Metric	Value
cc	7
c	0
b	0
f	0
dl	0
loc	33
rs	5.5
ccs	12
cts	12
cp	1
crap	7

import collections

from django.conf import settings
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from django.utils import translation
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3


class LocalizedValue(dict):
    """Represents the value of a :see:LocalizedField."""

    def __init__(self, keys: dict=None):
class SomeParent:
    def __init__(self):
        self.x = 1

class SomeChild(SomeParent):
    def __init__(self):
        # Initialize the super class
        SomeParent.__init__(self)
        """Initializes a new instance of :see:LocalizedValue.

        Arguments:
            keys:
                The keys to initialize this value with. Every
                key contains the value of this field in a
                different language.
        """

        self._interpret_value(keys);


    def get(self, language: str=None) -> str:
        """Gets the underlying value in the specified or
        primary language.

        Arguments:
            language:
                The language to get the value in.

        Returns:
            The value in the current language, or
            the primary language in case no language
            was specified.
        """

        language = language or settings.LANGUAGE_CODE
        return super().get(language, None)

    def set(self, language: str, value: str):
        """Sets the value in the specified language.

        Arguments:
            language:
                The language to set the value in.

            value:
                The value to set.
        """

        self[language] = value
        self.__dict__.update(self)
        return self

    def deconstruct(self) -> dict:
        """Deconstructs this value into a primitive type.

        Returns:
            A dictionary with all the localized values
            contained in this instance.
        """

        path = 'localized_fields.fields.LocalizedValue'
        return path, [self.__dict__], {}

    def _interpret_value(self, value):
        """Interprets a value passed in the constructor as
        a :see:LocalizedValue.

        If string:
            Assumes it's the default language.

        If dict:
            Each key is a language and the value a string
            in that language.

        If list:
            Recurse into to apply rules above.

        Arguments:
            value:
                The value to interpret.
        """

        for lang_code, _ in settings.LANGUAGES:
            self.set(lang_code, None)

        if isinstance(value, str):
            self.set(settings.LANGUAGE_CODE, value)

        elif isinstance(value, dict):
            for lang_code, _ in settings.LANGUAGES:
                lang_value = value.get(lang_code) or None
                self.set(lang_code, lang_value)

        elif isinstance(value, collections.Iterable):
            for val in value:
                self._interpret_value(val)

    def __str__(self) -> str:
        """Gets the value in the current language, or falls
        back to the primary language if there's no value
        in the current language."""

        value = self.get(translation.get_language())

        if not value:
            value = self.get(settings.LANGUAGE_CODE)

        return value or ''

    def __eq__(self, other):
        """Compares :paramref:self to :paramref:other for
        equality.

        Returns:
            True when :paramref:self is equal to :paramref:other.
            And False when they are not.
        """

        if not isinstance(other, type(self)):
            if isinstance(other, str):
                return self.__str__() == other
            return False

        for lang_code, _ in settings.LANGUAGES:
            if self.get(lang_code) != other.get(lang_code):
                return False

        return True

    def __ne__(self, other):
        """Compares :paramref:self to :paramerf:other for
        in-equality.

        Returns:
            True when :paramref:self is not equal to :paramref:other.
            And False when they are.
        """

        return not self.__eq__(other)

    def __setattr__(self, language: str, value: str):
        """Sets the value for a language with the specified name.

        Arguments:
            language:
                The language to set the value in.

            value:
                The value to set.
        """

        self.set(language, value)

    def __repr__(self):  # pragma: no cover
        """Gets a textual representation of this object."""

        return 'LocalizedValue<%s> 0x%s' % (dict(self), id(self))


1	1	import collections
2
3	1	from django.conf import settings
		0 ignored issues – show Configuration introduced 2017-05-25 16:25 UTC by Report Bug Copy Issue Report The import `django.conf` 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...
4	1	from django.utils import translation
		0 ignored issues – show Configuration introduced 2017-05-25 16:17 UTC by Report Bug Copy Issue Report The import `django.utils` 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...
5
6
7	1	class LocalizedValue(dict):
8		"""Represents the value of a :see:LocalizedField."""
9
10	1	def __init__(self, keys: dict=None):
		0 ignored issues – show Bug introduced 2017-03-09 12:34 UTC by Report Bug Copy Issue Report The `__init__` method of the super-class `dict` is not called. It is generally advisable to initialize the super-class by calling its `__init__` method: class SomeParent: def __init__(self): self.x = 1 class SomeChild(SomeParent): def __init__(self): # Initialize the super class SomeParent.__init__(self) Loading history...
11		"""Initializes a new instance of :see:LocalizedValue.
12
13		Arguments:
14		keys:
15		The keys to initialize this value with. Every
16		key contains the value of this field in a
17		different language.
18		"""
19
20	1	self._interpret_value(keys);
		0 ignored issues – show Coding Style introduced 2017-05-25 16:25 UTC by Report Bug Copy Issue Report Unnecessary semicolon Loading history...
21
22	1	def get(self, language: str=None) -> str:
23		"""Gets the underlying value in the specified or
24		primary language.
25
26		Arguments:
27		language:
28		The language to get the value in.
29
30		Returns:
31		The value in the current language, or
32		the primary language in case no language
33		was specified.
34		"""
35
36	1	language = language or settings.LANGUAGE_CODE
37	1	return super().get(language, None)
38
39	1	def set(self, language: str, value: str):
40		"""Sets the value in the specified language.
41
42		Arguments:
43		language:
44		The language to set the value in.
45
46		value:
47		The value to set.
48		"""
49
50	1	self[language] = value
51	1	self.__dict__.update(self)
52	1	return self
53
54	1	def deconstruct(self) -> dict:
55		"""Deconstructs this value into a primitive type.
56
57		Returns:
58		A dictionary with all the localized values
59		contained in this instance.
60		"""
61
62	1	path = 'localized_fields.fields.LocalizedValue'
63	1	return path, [self.__dict__], {}
64
65	1	def _interpret_value(self, value):
66		"""Interprets a value passed in the constructor as
67		a :see:LocalizedValue.
68
69		If string:
70		Assumes it's the default language.
71
72		If dict:
73		Each key is a language and the value a string
74		in that language.
75
76		If list:
77		Recurse into to apply rules above.
78
79		Arguments:
80		value:
81		The value to interpret.
82		"""
83
84	1	for lang_code, _ in settings.LANGUAGES:
85	1	self.set(lang_code, None)
86
87	1	if isinstance(value, str):
88	1	self.set(settings.LANGUAGE_CODE, value)
89
90	1	elif isinstance(value, dict):
91	1	for lang_code, _ in settings.LANGUAGES:
92	1	lang_value = value.get(lang_code) or None
93	1	self.set(lang_code, lang_value)
94
95	1	elif isinstance(value, collections.Iterable):
96	1	for val in value:
97	1	self._interpret_value(val)
98
99	1	def __str__(self) -> str:
100		"""Gets the value in the current language, or falls
101		back to the primary language if there's no value
102		in the current language."""
103
104	1	value = self.get(translation.get_language())
105
106	1	if not value:
107	1	value = self.get(settings.LANGUAGE_CODE)
108
109	1	return value or ''
110
111	1	def __eq__(self, other):
112		"""Compares :paramref:self to :paramref:other for
113		equality.
114
115		Returns:
116		True when :paramref:self is equal to :paramref:other.
117		And False when they are not.
118		"""
119
120	1	if not isinstance(other, type(self)):
121		if isinstance(other, str):
122		return self.__str__() == other
123		return False
124
125	1	for lang_code, _ in settings.LANGUAGES:
126	1	if self.get(lang_code) != other.get(lang_code):
127	1	return False
128
129	1	return True
130
131	1	def __ne__(self, other):
132		"""Compares :paramref:self to :paramerf:other for
133		in-equality.
134
135		Returns:
136		True when :paramref:self is not equal to :paramref:other.
137		And False when they are.
138		"""
139
140	1	return not self.__eq__(other)
141
142	1	def __setattr__(self, language: str, value: str):
143		"""Sets the value for a language with the specified name.
144
145		Arguments:
146		language:
147		The language to set the value in.
148
149		value:
150		The value to set.
151		"""
152
153	1	self.set(language, value)
154
155		def __repr__(self): # pragma: no cover
156		"""Gets a textual representation of this object."""
157
158		return 'LocalizedValue<%s> 0x%s' % (dict(self), id(self))
159

Push — master ( 0fa79d...5a4f44 )

LocalizedValue._interpret_value() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

SectorLabs / django-localized-fields

Push — master ( 0fa79d...5a4f44 )

LocalizedValue._interpret_value() C

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