LocalizedFileValue.localized() - Code Metrics - Inspection of "Extra fields" - SectorLabs/django-localized-fields - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#15)

unknown

created 2017-04-24 17:30 UTC

LocalizedFileValue.localized() A

↳ Parent: LocalizedFileValue

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.125

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
c	1
b	0
f	1
dl	0
loc	3
ccs	1
cts	2
cp	0.5
crap	1.125
rs	10

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."""
    default_value = None

    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.
        """

        # NOTE(seroy): First fill all the keys with default value,
        # in order to attributes will be for each language
        for lang_code, _ in settings.LANGUAGES:
            value = keys.get(lang_code) if isinstance(keys, dict) else \
                self.default_value
            self.set(lang_code, value)

        if isinstance(keys, str):
            setattr(self, settings.LANGUAGE_CODE, 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.localized_value.%s' % self.__class__.__name__
        return path, [self.__dict__], {}

    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 '%s<%s> 0x%s' % (self.__class__.__name__,
                                self.__dict__, id(self))


class LocalizedStingValue(LocalizedValue):
    default_value = ''


class LocalizedFileValue(LocalizedValue):
    def __getattr__(self, name: str):
        """Proxies access to attributes to attributes of LocalizedFile"""

        value = self.get(translation.get_language())
        if hasattr(value, name):
            return getattr(value, name)
        raise AttributeError("'{}' object has no attribute '{}'".
                             format(self.__class__.__name__, name))

    def __str__(self) -> str:
        """Returns string representation of value"""
        return str(super().__str__())

    def localized(self):
        """Returns value for current language"""
        return self.get(translation.get_language())


1	1	from django.conf import settings
		0 ignored issues – show Configuration introduced 2017-02-23 14:51 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...
2	1	from django.utils import translation
		0 ignored issues – show Configuration introduced 2017-02-23 14:51 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...
3
4
5	1	class LocalizedValue(dict):
6		"""Represents the value of a :see:LocalizedField."""
7	1	default_value = None
8
9	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...
10		"""Initializes a new instance of :see:LocalizedValue.
11
12		Arguments:
13		keys:
14		The keys to initialize this value with. Every
15		key contains the value of this field in a
16		different language.
17		"""
18
19		# NOTE(seroy): First fill all the keys with default value,
20		# in order to attributes will be for each language
21	1	for lang_code, _ in settings.LANGUAGES:
22	1	value = keys.get(lang_code) if isinstance(keys, dict) else \
23		self.default_value
24	1	self.set(lang_code, value)
25
26	1	if isinstance(keys, str):
27	1	setattr(self, settings.LANGUAGE_CODE, keys)
28
29	1	def get(self, language: str=None) -> str:
30		"""Gets the underlying value in the specified or
31		primary language.
32
33		Arguments:
34		language:
35		The language to get the value in.
36
37		Returns:
38		The value in the current language, or
39		the primary language in case no language
40		was specified.
41		"""
42
43	1	language = language or settings.LANGUAGE_CODE
44	1	return super().get(language, None)
45
46	1	def set(self, language: str, value: str):
47		"""Sets the value in the specified language.
48
49		Arguments:
50		language:
51		The language to set the value in.
52
53		value:
54		The value to set.
55		"""
56
57	1	self[language] = value
58	1	self.__dict__.update(self)
59	1	return self
60
61	1	def deconstruct(self) -> dict:
62		"""Deconstructs this value into a primitive type.
63
64		Returns:
65		A dictionary with all the localized values
66		contained in this instance.
67		"""
68
69	1	path = 'localized_fields.localized_value.%s' % self.__class__.__name__
70	1	return path, [self.__dict__], {}
71
72	1	def __str__(self) -> str:
73		"""Gets the value in the current language, or falls
74		back to the primary language if there's no value
75		in the current language."""
76
77	1	value = self.get(translation.get_language())
78
79	1	if not value:
80	1	value = self.get(settings.LANGUAGE_CODE)
81
82	1	return value or ''
83
84	1	def __eq__(self, other):
85		"""Compares :paramref:self to :paramref:other for
86		equality.
87
88		Returns:
89		True when :paramref:self is equal to :paramref:other.
90		And False when they are not.
91		"""
92
93	1	if not isinstance(other, type(self)):
94	1	if isinstance(other, str):
95	1	return self.__str__() == other
96	1	return False
97
98	1	for lang_code, _ in settings.LANGUAGES:
99	1	if self.get(lang_code) != other.get(lang_code):
100	1	return False
101
102	1	return True
103
104	1	def __ne__(self, other):
105		"""Compares :paramref:self to :paramerf:other for
106		in-equality.
107
108		Returns:
109		True when :paramref:self is not equal to :paramref:other.
110		And False when they are.
111		"""
112
113	1	return not self.__eq__(other)
114
115	1	def __setattr__(self, language: str, value: str):
116		"""Sets the value for a language with the specified name.
117
118		Arguments:
119		language:
120		The language to set the value in.
121
122		value:
123		The value to set.
124		"""
125
126	1	self.set(language, value)
127
128		def __repr__(self): # pragma: no cover
129		"""Gets a textual representation of this object."""
130
131		return '%s<%s> 0x%s' % (self.__class__.__name__,
132		self.__dict__, id(self))
133
134
135	1	class LocalizedStingValue(LocalizedValue):
136	1	default_value = ''
137
138
139	1	class LocalizedFileValue(LocalizedValue):
140	1	def __getattr__(self, name: str):
141		"""Proxies access to attributes to attributes of LocalizedFile"""
142
143	1	value = self.get(translation.get_language())
144	1	if hasattr(value, name):
145	1	return getattr(value, name)
146	1	raise AttributeError("'{}' object has no attribute '{}'".
147		format(self.__class__.__name__, name))
148
149	1	def __str__(self) -> str:
150		"""Returns string representation of value"""
151	1	return str(super().__str__())
152
153	1	def localized(self):
154		"""Returns value for current language"""
155		return self.get(translation.get_language())
156

Pull Request — master (#15)

LocalizedFileValue.localized() A

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

Pull Request — master (#15)

LocalizedFileValue.localized() 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