UserSerializer.update() - Code Metrics - Inspection of "Update UserView and UserSerializer" - sunscrapers/djoser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( cb96a6...03dbbf )

by Piotr

created 2017-08-25 17:23 UTC

UserSerializer.update() A

↳ Parent:

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	8
rs	9.2
cc	4

from django.contrib.auth import authenticate, get_user_model
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
from django.db import IntegrityError, transaction


from rest_framework import exceptions, serializers


from djoser import constants, utils
from djoser.compat import (
    get_user_email, get_user_email_field_name, validate_password
)
from djoser.conf import settings

User = get_user_model()



class UserSerializer(serializers.ModelSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    class Meta:
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        model = User
        fields = tuple(User.REQUIRED_FIELDS) + (
            User._meta.pk.name,
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            User.USERNAME_FIELD,
        )
        read_only_fields = (User.USERNAME_FIELD,)

    def update(self, instance, validated_data):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        email_field = get_user_email_field_name(User)
        if settings.SEND_ACTIVATION_EMAIL and email_field in validated_data:
            instance_email = get_user_email(instance)
            if instance_email != validated_data[email_field]:
                instance.is_active = False
                instance.save(update_fields=['is_active'])
        return super(UserSerializer, self).update(instance, validated_data)


class UserRegistrationSerializer(serializers.ModelSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    password = serializers.CharField(
        style={'input_type': 'password'},
        write_only=True
    )

    default_error_messages = {
        'cannot_create_user': constants.CANNOT_CREATE_USER_ERROR,
    }

    class Meta:
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        model = User
        fields = tuple(User.REQUIRED_FIELDS) + (
            User.USERNAME_FIELD, User._meta.pk.name, 'password',
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
        )

    def validate_password(self, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        validate_password(value)
        return value

    def create(self, validated_data):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        try:
            user = self.perform_create(validated_data)
        except IntegrityError:
            raise serializers.ValidationError(
                self.error_messages['cannot_create_user']
            )

        return user

    def perform_create(self, validated_data):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with transaction.atomic():
            user = User.objects.create_user(**validated_data)
            if settings.SEND_ACTIVATION_EMAIL:
                user.is_active = False
                user.save(update_fields=['is_active'])
        return user


class LoginSerializer(serializers.Serializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    password = serializers.CharField(
        required=False, style={'input_type': 'password'}
    )

    default_error_messages = {
        'inactive_account': constants.INACTIVE_ACCOUNT_ERROR,
        'invalid_credentials': constants.INVALID_CREDENTIALS_ERROR,
    }

    def __init__(self, *args, **kwargs):
        super(LoginSerializer, self).__init__(*args, **kwargs)
        self.user = None
        self.fields[User.USERNAME_FIELD] = serializers.CharField(
            required=False
        )

    def validate(self, attrs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.user = authenticate(
            username=attrs.get(User.USERNAME_FIELD),
            password=attrs.get('password')
        )

        self._validate_user_exists(self.user)
        self._validate_user_is_active(self.user)
        return attrs

    def _validate_user_exists(self, user):
        if not user:
            raise serializers.ValidationError(
                self.error_messages['invalid_credentials']
            )

    def _validate_user_is_active(self, user):
        if not user.is_active:
            raise serializers.ValidationError(
                self.error_messages['inactive_account']
            )


class PasswordResetSerializer(serializers.Serializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    email = serializers.EmailField()

    default_error_messages = {
        'email_not_found': constants.EMAIL_NOT_FOUND
    }

    def validate_email(self, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        users = self.context['view'].get_users(value)
        if settings.PASSWORD_RESET_SHOW_EMAIL_NOT_FOUND and not users:
            raise serializers.ValidationError(
                self.error_messages['email_not_found']
            )
        return value


class UidAndTokenSerializer(serializers.Serializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    uid = serializers.CharField()
    token = serializers.CharField()

    default_error_messages = {
        'invalid_token': constants.INVALID_TOKEN_ERROR,
        'invalid_uid': constants.INVALID_UID_ERROR,
    }

    def validate_uid(self, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        try:
            uid = utils.decode_uid(value)
            self.user = User.objects.get(pk=uid)
class Foo:
    def __init__(self, x=None):
        self.x = x
        except (User.DoesNotExist, ValueError, TypeError, OverflowError):
            raise serializers.ValidationError(
                self.error_messages['invalid_uid']
            )
        return value

    def validate(self, attrs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        attrs = super(UidAndTokenSerializer, self).validate(attrs)
        is_token_valid = self.context['view'].token_generator.check_token(
            self.user, attrs['token']
        )
        if is_token_valid:
            return attrs
        raise serializers.ValidationError(self.error_messages['invalid_token'])


class ActivationSerializer(UidAndTokenSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    default_error_messages = {
        'stale_token': constants.STALE_TOKEN_ERROR,
    }

    def validate(self, attrs):
        attrs = super(ActivationSerializer, self).validate(attrs)
        if not self.user.is_active:
            return attrs
        raise exceptions.PermissionDenied(self.error_messages['stale_token'])


class PasswordSerializer(serializers.Serializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    new_password = serializers.CharField(style={'input_type': 'password'})

    def validate_new_password(self, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        validate_password(value)
        return value


class PasswordRetypeSerializer(PasswordSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    re_new_password = serializers.CharField(style={'input_type': 'password'})

    default_error_messages = {
        'password_mismatch': constants.PASSWORD_MISMATCH_ERROR,
    }

    def validate(self, attrs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        attrs = super(PasswordRetypeSerializer, self).validate(attrs)
        if attrs['new_password'] == attrs['re_new_password']:
            return attrs
        raise serializers.ValidationError(
            self.error_messages['password_mismatch']
        )


class CurrentPasswordSerializer(serializers.Serializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    current_password = serializers.CharField(style={'input_type': 'password'})

    default_error_messages = {
        'invalid_password': constants.INVALID_PASSWORD_ERROR,
    }

    def validate_current_password(self, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        is_password_valid = self.context['request'].user.check_password(value)
        if is_password_valid:
            return value
        raise serializers.ValidationError(
            self.error_messages['invalid_password']
        )


class SetPasswordSerializer(PasswordSerializer, CurrentPasswordSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    pass


class SetPasswordRetypeSerializer(PasswordRetypeSerializer,
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                                  CurrentPasswordSerializer):
    pass


class PasswordResetConfirmSerializer(UidAndTokenSerializer,
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                                     PasswordSerializer):
    pass


class PasswordResetConfirmRetypeSerializer(UidAndTokenSerializer,
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                                           PasswordRetypeSerializer):
    pass


class SetUsernameSerializer(serializers.ModelSerializer,
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                            CurrentPasswordSerializer):

    class Meta(object):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        model = User
        fields = (
            User.USERNAME_FIELD,
            'current_password',
        )

    def __init__(self, *args, **kwargs):
        """
        This method should probably be replaced by a better solution.
        Its purpose is to replace USERNAME_FIELD with 'new_' + USERNAME_FIELD
        so that the new field is being assigned a field for USERNAME_FIELD
        """
        super(SetUsernameSerializer, self).__init__(*args, **kwargs)
        username_field = User.USERNAME_FIELD
        self.fields['new_' + username_field] = self.fields.pop(username_field)


class SetUsernameRetypeSerializer(SetUsernameSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    default_error_messages = {
        'username_mismatch': constants.USERNAME_MISMATCH_ERROR.format(
            User.USERNAME_FIELD
        ),
    }

    def __init__(self, *args, **kwargs):
        super(SetUsernameRetypeSerializer, self).__init__(*args, **kwargs)
        self.fields['re_new_' + User.USERNAME_FIELD] = serializers.CharField()

    def validate(self, attrs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        attrs = super(SetUsernameRetypeSerializer, self).validate(attrs)
        new_username = attrs[User.USERNAME_FIELD]
        if new_username != attrs['re_new_' + User.USERNAME_FIELD]:
            raise serializers.ValidationError(
                self.error_messages['username_mismatch'].format(
                    User.USERNAME_FIELD
                )
            )
        return attrs


class TokenSerializer(serializers.ModelSerializer):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    auth_token = serializers.CharField(source='key')

    class Meta:
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        model = settings.TOKEN_MODEL
        fields = (
            'auth_token',
        )


1			from django.contrib.auth import authenticate, get_user_model
			0 ignored issues – show Coding Style introduced 2017-08-24 11:14 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... introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report Unable to import 'django.contrib.auth' Loading history...
2			from django.db import IntegrityError, transaction
			0 ignored issues – show introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report Unable to import 'django.db' Loading history...
3
4			from rest_framework import exceptions, serializers
			0 ignored issues – show introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report Unable to import 'rest_framework' Loading history...
5
6			from djoser import constants, utils
7			from djoser.compat import (
8			get_user_email, get_user_email_field_name, validate_password
9			)
10			from djoser.conf import settings
11
12			User = get_user_model()
			0 ignored issues – show Coding Style Naming introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report The name `User` does not conform to the constant naming conventions (`(([A-Z_][A-Z0-9_])\|(__.__))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
13
14
15			class UserSerializer(serializers.ModelSerializer):
			0 ignored issues – show Coding Style introduced 2017-08-24 11:14 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...
16			class Meta:
			0 ignored issues – show Coding Style introduced 2017-08-24 11:14 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... introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report Old-style class defined. Loading history... Coding Style introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report This class has no `__init__` method. Loading history...
17			model = User
18			fields = tuple(User.REQUIRED_FIELDS) + (
19			User._meta.pk.name,
			0 ignored issues – show Coding Style Best Practice introduced 2017-08-24 11:14 UTC by Report Bug Copy Issue Report It seems like `_meta` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
20			User.USERNAME_FIELD,
21			)
22			read_only_fields = (User.USERNAME_FIELD,)
23
24			def update(self, instance, validated_data):
			0 ignored issues – show Coding Style introduced 2017-08-25 17:25 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...
25			email_field = get_user_email_field_name(User)
26			if settings.SEND_ACTIVATION_EMAIL and email_field in validated_data:
27			instance_email = get_user_email(instance)
28			if instance_email != validated_data[email_field]:
29			instance.is_active = False
30			instance.save(update_fields=['is_active'])
31			return super(UserSerializer, self).update(instance, validated_data)
32

sunscrapers / djoser

Push — master ( cb96a6...03dbbf )

UserSerializer.update() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like