LocalizedFileFieldForm.bound_data() - 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-13 08:12 UTC

LocalizedFileFieldForm.bound_data() B

↳ Parent: LocalizedFileFieldForm

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	33.0481

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	6
c	1
b	0
f	1
dl	0
loc	13
ccs	1
cts	11
cp	0.0909
crap	33.0481
rs	8

from typing import List
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from django import forms
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from django.conf import settings
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from django.core.exceptions import ValidationError
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from django.forms.widgets import FILE_INPUT_CONTRADICTION
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from .localized_value import LocalizedValue, LocalizedStingValue, \
    LocalizedFileValue
from .widgets import LocalizedFieldWidget, LocalizedCharFieldWidget, \
    LocalizedFileWidget


class LocalizedFieldForm(forms.MultiValueField):
    """Form for a localized field, allows editing
    the field in multiple languages."""

    widget = LocalizedFieldWidget
    field_class = forms.fields.CharField
    value_class = LocalizedValue

    def __init__(self, *args, **kwargs):
        """Initializes a new instance of :see:LocalizedFieldForm."""

        fields = []

        for lang_code, _ in settings.LANGUAGES:
            field_options = {'required': False}

            if lang_code == settings.LANGUAGE_CODE:
                field_options['required'] = kwargs.get('required', True)

            field_options['label'] = lang_code
            fields.append(self.field_class(**field_options))


        super(LocalizedFieldForm, self).__init__(
            fields,
            require_all_fields=False,
            *args, **kwargs
        )
        # set 'required' attribute for each widget separately
        for f, w in zip(self.fields, self.widget.widgets):

            w.is_required = f.required

    def compress(self, value: List[str]) -> value_class:

        """Compresses the values from individual fields
        into a single :see:LocalizedValue instance.

        Arguments:
            value:
                The values from all the widgets.

        Returns:
            A :see:LocalizedValue containing all
            the value in several languages.
        """

        localized_value = self.value_class()

        for (lang_code, _), value in zip(settings.LANGUAGES, value):
            localized_value.set(lang_code, value)

        return localized_value


class LocalizedCharFieldForm(LocalizedFieldForm):
    """Form for a localized char field, allows editing
    the field in multiple languages."""

    widget = LocalizedCharFieldWidget
    value_class = LocalizedStingValue


class LocalizedTextFieldForm(LocalizedFieldForm):
    """Form for a localized text field, allows editing
    the field in multiple languages."""

    value_class = LocalizedStingValue


class LocalizedFileFieldForm(LocalizedFieldForm, forms.FileField):
    """Form for a localized file field, allows editing
    the field in multiple languages."""

    widget = LocalizedFileWidget
    field_class = forms.fields.FileField
    value_class = LocalizedFileValue

    def clean(self, value, initial=None):
        """
        Most part of this method is a copy of 

        django.forms.MultiValueField.clean, with the exception of initial
        value handling (this need for correct processing FileField's).
        All original comments saved.
        """
        if initial is None:
            initial = [None for x in range(0, len(value))]
        else:
            if not isinstance(initial, list):
                initial = self.widget.decompress(initial)

        clean_data = []
        errors = []
        if not value or isinstance(value, (list, tuple)):
            if (not value or not [v for v in value if
                                  v not in self.empty_values]) \

                    and (not initial or not [v for v in initial if
                                             v not in self.empty_values]):

                if self.required:

                    raise ValidationError(self.error_messages['required'],

                                          code='required')
        else:
            raise ValidationError(self.error_messages['invalid'],

                                  code='invalid')
        for i, field in enumerate(self.fields):

            try:
                field_value = value[i]
            except IndexError:
                field_value = None
            try:
                field_initial = initial[i]
            except IndexError:
                field_initial = None
            if field_value in self.empty_values and \

                            field_initial in self.empty_values:

                if self.require_all_fields:

                    # Raise a 'required' error if the MultiValueField is
                    # required and any field is empty.
                    if self.required:

                        raise ValidationError(self.error_messages['required'],

                                              code='required')
                elif field.required:
                    # Otherwise, add an 'incomplete' error to the list of
                    # collected errors and skip field cleaning, if a required
                    # field is empty.
                    if field.error_messages['incomplete'] not in errors:
                        errors.append(field.error_messages['incomplete'])
                    continue
            try:
                clean_data.append(field.clean(field_value, field_initial))
            except ValidationError as e:
                # Collect all validation errors in a single list, which we'll
                # raise at the end of clean(), rather than raising a single
                # exception for the first error we encounter. Skip duplicates.
                errors.extend(m for m in e.error_list if m not in errors)
        if errors:
            raise ValidationError(errors)

        out = self.compress(clean_data)
        self.validate(out)

        self.run_validators(out)

        return out

    def bound_data(self, data, initial):
        bound_data = []
        if initial is None:
            initial = [None for x in range(0, len(data))]
        else:
            if not isinstance(initial, list):
                initial = self.widget.decompress(initial)
        for d, i in zip(data, initial):
            if d in (None, FILE_INPUT_CONTRADICTION):
                bound_data.append(i)
            else:
                bound_data.append(d)
        return bound_data


1	1	from typing import List
		0 ignored issues – show Configuration introduced 2017-02-23 14:51 UTC by Report Bug Copy Issue Report The import `typing` 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
3	1	from django import forms
		0 ignored issues – show Configuration introduced 2017-02-23 14:51 UTC by Report Bug Copy Issue Report The import `django` 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.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...
5	1	from django.core.exceptions import ValidationError
		0 ignored issues – show Configuration introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The import `django.core.exceptions` 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...
6	1	from django.forms.widgets import FILE_INPUT_CONTRADICTION
		0 ignored issues – show Configuration introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The import `django.forms.widgets` 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
8	1	from .localized_value import LocalizedValue, LocalizedStingValue, \
9		LocalizedFileValue
10	1	from .widgets import LocalizedFieldWidget, LocalizedCharFieldWidget, \
11		LocalizedFileWidget
12
13
14	1	class LocalizedFieldForm(forms.MultiValueField):
15		"""Form for a localized field, allows editing
16		the field in multiple languages."""
17
18	1	widget = LocalizedFieldWidget
19	1	field_class = forms.fields.CharField
20	1	value_class = LocalizedValue
21
22	1	def __init__(self, args, *kwargs):
23		"""Initializes a new instance of :see:LocalizedFieldForm."""
24
25	1	fields = []
26
27	1	for lang_code, _ in settings.LANGUAGES:
28	1	field_options = {'required': False}
29
30	1	if lang_code == settings.LANGUAGE_CODE:
31	1	field_options['required'] = kwargs.get('required', True)
32
33	1	field_options['label'] = lang_code
34	1	fields.append(self.field_class(**field_options))
		0 ignored issues – show Coding Style introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report Usage of `` or `` arguments should usually be done with care. Generally, there is nothing wrong with usage of `` or `**` arguments. For readability of the code base, we suggest to not over-use these language constructs though. For more information, we can recommend this blog post from Ned Batchelder including its comments which also touches this aspect. Loading history...
35
36	1	super(LocalizedFieldForm, self).__init__(
37		fields,
38		require_all_fields=False,
39		args, *kwargs
40		)
41		# set 'required' attribute for each widget separately
42	1	for f, w in zip(self.fields, self.widget.widgets):
		0 ignored issues – show Bug introduced 2017-03-17 15:37 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFieldForm` does not seem to have a member named `fields`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history... Bug introduced 2017-03-17 15:37 UTC by Report Bug Copy Issue Report The Class `LocalizedFieldWidget` does not seem to have a member named `widgets`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
43	1	w.is_required = f.required
44
45	1	def compress(self, value: List[str]) -> value_class:
		0 ignored issues – show Comprehensibility Best Practice introduced 2017-01-13 02:12 UTC by Report Bug Copy Issue Report Undefined variable 'value_class' Loading history...
46		"""Compresses the values from individual fields
47		into a single :see:LocalizedValue instance.
48
49		Arguments:
50		value:
51		The values from all the widgets.
52
53		Returns:
54		A :see:LocalizedValue containing all
55		the value in several languages.
56		"""
57
58	1	localized_value = self.value_class()
59
60	1	for (lang_code, _), value in zip(settings.LANGUAGES, value):
61	1	localized_value.set(lang_code, value)
62
63	1	return localized_value
64
65
66	1	class LocalizedCharFieldForm(LocalizedFieldForm):
67		"""Form for a localized char field, allows editing
68		the field in multiple languages."""
69
70	1	widget = LocalizedCharFieldWidget
71	1	value_class = LocalizedStingValue
72
73
74	1	class LocalizedTextFieldForm(LocalizedFieldForm):
75		"""Form for a localized text field, allows editing
76		the field in multiple languages."""
77
78	1	value_class = LocalizedStingValue
79
80
81	1	class LocalizedFileFieldForm(LocalizedFieldForm, forms.FileField):
82		"""Form for a localized file field, allows editing
83		the field in multiple languages."""
84
85	1	widget = LocalizedFileWidget
86	1	field_class = forms.fields.FileField
87	1	value_class = LocalizedFileValue
88
89	1	def clean(self, value, initial=None):
90		"""
91		Most part of this method is a copy of
		0 ignored issues – show Coding Style introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
92		django.forms.MultiValueField.clean, with the exception of initial
93		value handling (this need for correct processing FileField's).
94		All original comments saved.
95		"""
96		if initial is None:
97		initial = [None for x in range(0, len(value))]
98		else:
99		if not isinstance(initial, list):
100		initial = self.widget.decompress(initial)
101
102		clean_data = []
103		errors = []
104		if not value or isinstance(value, (list, tuple)):
105		if (not value or not [v for v in value if
106		v not in self.empty_values]) \
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `empty_values`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
107		and (not initial or not [v for v in initial if
108		v not in self.empty_values]):
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `empty_values`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
109		if self.required:
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `required`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
110		raise ValidationError(self.error_messages['required'],
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `error_messages`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
111		code='required')
112		else:
113		raise ValidationError(self.error_messages['invalid'],
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `error_messages`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
114		code='invalid')
115		for i, field in enumerate(self.fields):
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `fields`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
116		try:
117		field_value = value[i]
118		except IndexError:
119		field_value = None
120		try:
121		field_initial = initial[i]
122		except IndexError:
123		field_initial = None
124		if field_value in self.empty_values and \
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `empty_values`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
125		field_initial in self.empty_values:
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `empty_values`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
126		if self.require_all_fields:
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `require_all_fields`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
127		# Raise a 'required' error if the MultiValueField is
128		# required and any field is empty.
129		if self.required:
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `required`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
130		raise ValidationError(self.error_messages['required'],
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `error_messages`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
131		code='required')
132		elif field.required:
133		# Otherwise, add an 'incomplete' error to the list of
134		# collected errors and skip field cleaning, if a required
135		# field is empty.
136		if field.error_messages['incomplete'] not in errors:
137		errors.append(field.error_messages['incomplete'])
138		continue
139		try:
140		clean_data.append(field.clean(field_value, field_initial))
141		except ValidationError as e:
142		# Collect all validation errors in a single list, which we'll
143		# raise at the end of clean(), rather than raising a single
144		# exception for the first error we encounter. Skip duplicates.
145		errors.extend(m for m in e.error_list if m not in errors)
146		if errors:
147		raise ValidationError(errors)
148
149		out = self.compress(clean_data)
150		self.validate(out)
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `validate`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
151		self.run_validators(out)
		0 ignored issues – show Bug introduced 2017-04-13 08:13 UTC by Report Bug Copy Issue Report The Instance of `LocalizedFileFieldForm` does not seem to have a member named `run_validators`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
152		return out
153
154	1	def bound_data(self, data, initial):
155		bound_data = []
156		if initial is None:
157		initial = [None for x in range(0, len(data))]
158		else:
159		if not isinstance(initial, list):
160		initial = self.widget.decompress(initial)
161		for d, i in zip(data, initial):
162		if d in (None, FILE_INPUT_CONTRADICTION):
163		bound_data.append(i)
164		else:
165		bound_data.append(d)
166		return bound_data
167

Pull Request — master (#15)

LocalizedFileFieldForm.bound_data() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

SectorLabs / django-localized-fields

Pull Request — master (#15)

LocalizedFileFieldForm.bound_data() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

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

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files